taxcalc 4.2.1__py3-none-any.whl → 4.3.0__py3-none-any.whl

taxcalc/__init__.py

@@ -14,4 +14,4 @@ from taxcalc.taxcalcio import *
 from taxcalc.utils import *
 from taxcalc.cli import *
 
-__version__ = '4.2.1'
+__version__ = '4.3.0'

taxcalc/assumptions/ASSUMPTIONS.md

@@ -0,0 +1,53 @@
+# HOW TO SPECIFY ECONOMIC ASSUMPTIONS IN A JSON ASSUMPTION FILE
+
+There is a way to specify in a text file the collection of economic
+assumptions about how individuals and the overall economy respond to a
+tax reform.
+
+Here we provide a link to an economic assumptions template file, and
+then provide a more general explanation of the structure and syntax of
+assumption files.
+
+## Example of an Economic Assumption File
+
+The following example serves as a template:
+
+- [Economic Assumptions Template](economic_assumptions_template.json)
+
+## Structure and Syntax of Assumption Files
+
+The assumption files are JSON files.  JSON, which stands for
+JavaScript Object Notation, is an easy way to specify structured
+information that is widely used.  Below we provide an abstract example
+of a JSON assumption file with some explanation.
+
+Here is an abstract example of an economic assumption file that
+consists of several parameters.  The structure of this file is as
+follows:
+
+```
+{
+  "consumption": {
+     <parameter_name>: {<calyear>: <parameter-value>}
+  },
+  "growdiff_baseline": {
+  },
+  "growdiff_response": {
+     <parameter_name>: {<calyear>: <parameter-value>}
+  }
+}
+```
+
+Notice that an assumption file must always contain these top-level keys:
+consumption, growdiff_baseline, and growdiff_response.
+Any key can have an empty value like the growdiff_baseline key above.
+Empty values mean that the default assumption parameter values are
+used.
+
+The rules about structuring a non-empty value for a top-level key are
+the same as for policy reform files, which are described
+[here](https://github.com/PSLmodels/Tax-Calculator/blob/master/taxcalc/reforms/REFORMS.md#how-to-specify-a-tax-reform-in-a-json-policy-reform-file).
+The assumption parameter names recognized by Tax-Calculator, and their
+default values, are listed in [this
+section](https://PSLmodels.github.io/Tax-Calculator/uguide.html#params)
+of the user guide.

taxcalc/assumptions/README.md

@@ -0,0 +1,17 @@
+Economic Assumption Files
+-------------------------
+
+This directory contains an example of an economic assumption file that can
+be combined and modified to construct your own economic assumption files
+that are stored on your local computer.
+
+Such an economic assumption file can then be used by the `tc`
+command-line interface to Tax-Calculator or be read in a Python
+program that imports the Tax-Calculator `taxcalc` package, as
+described in the [user
+guide](https://PSLmodels.github.io/Tax-Calculator/uguide.html).
+
+[This
+document](https://github.com/PSLmodels/Tax-Calculator/blob/master/taxcalc/assumptions/ASSUMPTIONS.md#how-to-specify-economic-assumptions-in-a-json-assumption-file)
+provides access to a template economic assumption file and guidelines
+about how to prepare your own assumption files.

taxcalc/assumptions/economic_assumptions_template.json

@@ -0,0 +1,77 @@
+// Parameters used to specify economic assumptions used in tax policy analysis.
+//
+// This JSON file serves as a template for specifying economic assumptions
+// about how individuals and the overall economy respond to a tax reform.
+//
+// Detailed documentation on these parameters can be found at
+// <http://PSLmodels.github.io/Tax-Calculator/#params>.
+{
+    "consumption": {
+        "MPC_e17500": {"2017": 0.0},
+        "MPC_e18400": {"2017": 0.0},
+        "MPC_e19800": {"2017": 0.0},
+        "MPC_e20400": {"2017": 0.0},
+        "BEN_housing_value": {"2017": 1.0},
+        "BEN_snap_value": {"2017": 1.0},
+        "BEN_tanf_value": {"2017": 1.0},
+        "BEN_vet_value": {"2017": 1.0},
+        "BEN_wic_value": {"2017": 1.0},
+        "BEN_mcare_value": {"2017": 1.0},
+        "BEN_mcaid_value": {"2017": 1.0},
+        "BEN_other_value": {"2017": 1.0}
+    },
+    "growdiff_baseline": {
+        "ABOOK": {"2017": 0.0},
+        "ACGNS": {"2017": 0.0},
+        "ACPIM": {"2017": 0.0},
+        "ACPIU": {"2017": 0.0},
+        "ADIVS": {"2017": 0.0},
+        "AINTS": {"2017": 0.0},
+        "AIPD": {"2017": 0.0},
+        "ASCHCI": {"2017": 0.0},
+        "ASCHCL": {"2017": 0.0},
+        "ASCHEI": {"2017": 0.0},
+        "ASCHEL": {"2017": 0.0},
+        "ASCHF": {"2017": 0.0},
+        "ASOCSEC": {"2017": 0.0},
+        "ATXPY": {"2017": 0.0},
+        "AUCOMP": {"2017": 0.0},
+        "AWAGE": {"2017": 0.0},
+        "ABENOTHER": {"2017": 0.0},
+        "ABENMCARE": {"2017": 0.0},
+        "ABENMCAID": {"2017": 0.0},
+        "ABENSSI": {"2017": 0.0},
+        "ABENSNAP": {"2017": 0.0},
+        "ABENWIC": {"2017": 0.0},
+        "ABENHOUSING": {"2017": 0.0},
+        "ABENTANF": {"2017": 0.0},
+        "ABENVET": {"2017": 0.0}
+    },
+    "growdiff_response": {
+        "ABOOK": {"2017": 0.0},
+        "ACGNS": {"2017": 0.0},
+        "ACPIM": {"2017": 0.0},
+        "ACPIU": {"2017": 0.0},
+        "ADIVS": {"2017": 0.0},
+        "AINTS": {"2017": 0.0},
+        "AIPD": {"2017": 0.0},
+        "ASCHCI": {"2017": 0.0},
+        "ASCHCL": {"2017": 0.0},
+        "ASCHEI": {"2017": 0.0},
+        "ASCHEL": {"2017": 0.0},
+        "ASCHF": {"2017": 0.0},
+        "ASOCSEC": {"2017": 0.0},
+        "ATXPY": {"2017": 0.0},
+        "AUCOMP": {"2017": 0.0},
+        "AWAGE": {"2017": 0.0},
+        "ABENOTHER": {"2017": 0.0},
+        "ABENMCARE": {"2017": 0.0},
+        "ABENMCAID": {"2017": 0.0},
+        "ABENSSI": {"2017": 0.0},
+        "ABENSNAP": {"2017": 0.0},
+        "ABENWIC": {"2017": 0.0},
+        "ABENHOUSING": {"2017": 0.0},
+        "ABENTANF": {"2017": 0.0},
+        "ABENVET": {"2017": 0.0}
+    }
+}

taxcalc/calcfunctions.py

@@ -2809,7 +2809,7 @@ def SchR(age_head, age_spouse, MARS, c00100,
 
 
 @iterate_jit(nopython=True)
-def EducationTaxCredit(exact, e87530, MARS, c00100, num, c05800,
+def EducationTaxCredit(exact, e87530, MARS, c00100, c05800,
                        e07300, c07180, c07200, c87668,
                        LLC_Expense_c, ETC_pe_Single, ETC_pe_Married,
                        CR_Education_hc,
@@ -2828,8 +2828,6 @@ def EducationTaxCredit(exact, e87530, MARS, c00100, num, c05800,
         Filing (marital) status. (1=single, 2=joint, 3=separate, 4=household-head, 5=widow(er))
     c00100: float
         Adjusted Gross Income (AGI)
-    num: int
-        2 when MARS is 2 (married filing jointly), otherwise 1
     c05800: float
         Total (regular + AMT) income tax liability before credits
     e07300: float
@@ -2860,14 +2858,19 @@ def EducationTaxCredit(exact, e87530, MARS, c00100, num, c05800,
     -----
     Tax Law Parameters that are not parameterized:
         0.2: Lifetime Learning Credit ratio against expense
+        10000.0: AGI range bewteen ETC_pe_Single and single phase-out start;
+                 twice this amount for ETC_pe_Married
     """
     c87560 = 0.2 * min(e87530, LLC_Expense_c)
+    # on the following credit phase-out law see:
+    # https://www.law.cornell.edu/uscode/text/26/25A#d_1
     if MARS == 2:
         c87570 = ETC_pe_Married * 1000.
+        c87600 = 20000.
     else:
         c87570 = ETC_pe_Single * 1000.
+        c87600 = 10000.
     c87590 = max(0., c87570 - c00100)
-    c87600 = 10000. * num
     if exact == 1:  # exact calculation as on tax forms
         c87610 = min(1., round(c87590 / c87600, 3))
     else:

taxcalc/data.py

@@ -102,7 +102,7 @@ class Data():
                 # ... weights must be same size as data
                 if self.array_length > len(self.WT.index):
                     raise ValueError("Data has more records than weights.")
-                elif self.array_length < len(self.WT.index):
+                if self.array_length < len(self.WT.index):
                     # scale-up sub-sample weights by year-specific factor
                     sum_full_weights = self.WT.sum()
                     self.WT = self.WT.iloc[self.__index]
@@ -110,9 +110,11 @@ class Data():
                     factor = sum_full_weights / sum_sub_weights
                     self.WT *= factor
                 # ... construct sample weights for current_year
-                wt_colname = 'WT{}'.format(self.current_year)
-                if wt_colname in self.WT.columns:
-                    self.s006 = self.WT[wt_colname] * 0.01
+                wt_colname = f'WT{self.current_year}'
+                assert wt_colname in self.WT.columns, (
+                    f'no weights for start year {self.current_year}'
+                )
+                self.s006 = self.WT[wt_colname] * 0.01
 
     @property
     def data_year(self):
@@ -146,7 +148,10 @@ class Data():
             # ... apply variable extrapolation growth factors
             self._extrapolate(self.__current_year)
             # ... specify current-year sample weights
-            wt_colname = 'WT{}'.format(self.__current_year)
+            wt_colname = f'WT{self.__current_year}'
+            assert wt_colname in self.WT.columns, (
+                f'no weights for new year {self.current_year}'
+            )
             self.s006 = self.WT[wt_colname] * 0.01
 
     # ----- begin private methods of Data class -----

taxcalc/policy.py

@@ -37,7 +37,7 @@ class Policy(Parameters):
     DEFAULTS_FILE_NAME = 'policy_current_law.json'
     DEFAULTS_FILE_PATH = os.path.abspath(os.path.dirname(__file__))
     JSON_START_YEAR = 2013  # remains the same unless earlier data added
-    LAST_KNOWN_YEAR = 2022  # last year for which indexed param vals are known
+    LAST_KNOWN_YEAR = 2024  # last year for which indexed param vals are known
     # should increase LAST_KNOWN_YEAR by one every calendar year
     LAST_BUDGET_YEAR = 2034  # last extrapolation year
     # should increase LAST_BUDGET_YEAR by one every calendar year