From 523db007d0260d5f692b7144d430f1d1704892a1 Mon Sep 17 00:00:00 2001 From: jdebacker Date: Thu, 2 May 2024 22:50:06 -0400 Subject: [PATCH] add docstrings --- ogzaf/calibrate.py | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/ogzaf/calibrate.py b/ogzaf/calibrate.py index b70d012..1589ae7 100644 --- a/ogzaf/calibrate.py +++ b/ogzaf/calibrate.py @@ -24,6 +24,28 @@ def __init__( client=None, num_workers=1, ): + """ + Constructor for the Calibration class. + + Args: + p (OG-Core Specifications object): model parameters + estimate_tax_functions (bool): whether to estimate tax + function parameters + estimate_beta (bool): whether to estimate beta + estimate_chi_n (bool): whether to estimate chi_n + estimate_pop (bool): whether to estimate population + tax_func_path (str): path to tax function parameter + estimates + iit_reform (dict): IIT reform dictionary + guid (str): unique identifier for reform + data (str): type of data to use in tax function + client (Dask client object): client + num_workers (int): number of workers + + Returns: + None + + """ self.estimate_tax_functions = estimate_tax_functions self.estimate_beta = estimate_beta self.estimate_chi_n = estimate_chi_n @@ -121,7 +143,12 @@ def get_tax_function_parameters( parameters from microsimulation model output. Args: + p (OG-Core Specifications object): model parameters + iit_reform (dict): IIT reform dictionary + guid (string): unique identifier for reform + data (string): type of data to use in tax function client (Dask client object): client + num_workers (int): number of workers run_micro (bool): whether to estimate parameters from microsimulation model tax_func_path (string): path where find or save tax @@ -330,6 +357,7 @@ def read_tax_func_estimate(self, p, tax_func_path): files. Args: + p (OG-Core Specifications object): model parameters tax_func_path (str): path to pickle with tax function parameter estimates