taxcalc 5.3.0__py3-none-any.whl → 6.1.0__py3-none-any.whl

taxcalc/__init__.py

@@ -14,6 +14,6 @@ from taxcalc.taxcalcio import *
 from taxcalc.utils import *
 from taxcalc.cli import *
 
-__version__ = '5.3.0'
+__version__ = '6.1.0'
 __min_python3_version__ = 11
 __max_python3_version__ = 13

taxcalc/calcfunctions.py

@@ -1871,7 +1871,7 @@ def AMT(e07300, dwks13, standard, f6251, c00100, c18300, taxbc,
         dwks14, c05700, e62900, e00700, dwks10, age_head, age_spouse,
         earned, cmbtp, qbided,
         AMT_child_em_c_age, AMT_brk1,
-        AMT_em, AMT_prt, AMT_rt1, AMT_rt2,
+        AMT_em, AMT_prt, AMT_rt1, AMT_rt2_addon,
         AMT_child_em, AMT_em_ps, AMT_em_pe,
         AMT_CG_brk1, AMT_CG_brk2, AMT_CG_brk3, AMT_CG_rt1, AMT_CG_rt2,
         AMT_CG_rt3, AMT_CG_rt4, c05800, c09600, c62100):
@@ -1946,8 +1946,8 @@ def AMT(e07300, dwks13, standard, f6251, c00100, c18300, taxbc,
         AMT exemption phaseout rate
     AMT_rt1: float
         AMT rate 1
-    AMT_rt2: float
-        Additional AMT rate for AMT taxable income about AMT bracket 1
+    AMT_rt2_addon: float
+        Additional AMT rate for AMT taxable income above AMT bracket 1
     AMT_child_em: float
         Child AMT exemption additional income base
     AMT_em_ps: list
@@ -1977,14 +1977,14 @@ def AMT(e07300, dwks13, standard, f6251, c00100, c18300, taxbc,
     c09600: float
         Alternative Minimum Tax (AMT) liability
     c62100: float
-        Alternative Minimum Tax (AMT)
+        Alternative Minimum Tax (AMT) taxable income
 
     Returns
     -------
     c62100: float
-        Alternative Minimum Tax (AMT)
+        Alternative Minimum Tax (AMT) taxable income
     c09600: float
-        Alternative Minimum Tax (AMT) liability
+        Alternative Minimum Tax (AMT) tax liability
     c05800: float
         Total (regular + AMT) income tax liability before credits
     """
@@ -2012,7 +2012,7 @@ def AMT(e07300, dwks13, standard, f6251, c00100, c18300, taxbc,
         line29 = min(line29, earned + AMT_child_em)
     line30 = max(0., c62100 - line29)
     line3163 = (AMT_rt1 * line30 +
-                AMT_rt2 * max(0., (line30 - (AMT_brk1 / sep))))
+                AMT_rt2_addon * max(0., (line30 - (AMT_brk1 / sep))))
     if dwks10 > 0. or dwks13 > 0. or dwks14 > 0. or dwks19 > 0. or e24515 > 0.:
         # complete Form 6251, Part III (line36 is equal to line30)
         line37 = dwks13
@@ -2021,7 +2021,7 @@ def AMT(e07300, dwks13, standard, f6251, c00100, c18300, taxbc,
         line40 = min(line30, line39)
         line41 = max(0., line30 - line40)
         line42 = (AMT_rt1 * line41 +
-                  AMT_rt2 * max(0., (line41 - (AMT_brk1 / sep))))
+                  AMT_rt2_addon * max(0., (line41 - (AMT_brk1 / sep))))
         line44 = dwks14
         line45 = max(0., AMT_CG_brk1[MARS - 1] - line44)
         line46 = min(line30, line37)
@@ -2268,7 +2268,7 @@ def EITCamount(basic_frac, phasein_rate, earnings, max_amount,
 @iterate_jit(nopython=True)
 def EITC(MARS, DSI, EIC, c00100, e00300, e00400, e00600, c01000,
          e02000, e26270, age_head, age_spouse, earned, earned_p, earned_s,
-         EITC_ps, EITC_MinEligAge, EITC_MaxEligAge, EITC_ps_MarriedJ,
+         EITC_ps, EITC_MinEligAge, EITC_MaxEligAge, EITC_ps_addon_MarriedJ,
          EITC_rt, EITC_c, EITC_prt, EITC_basic_frac,
          EITC_InvestIncome_c, EITC_excess_InvestIncome_rt,
          EITC_indiv, EITC_sep_filers_elig, c59660):
@@ -2315,7 +2315,7 @@ def EITC(MARS, DSI, EIC, c00100, e00300, e00400, e00600, c01000,
         Minimum age for childless EITC eligibility
     EITC_MaxEligAge: int
         Maximum age for childless EITC eligibility
-    EITC_ps_MarriedJ: list
+    EITC_ps_addon_MarriedJ: list
         Extra earned income credit phaseout start AGI for
         married filling jointly
     EITC_rt: list
@@ -2360,7 +2360,7 @@ def EITC(MARS, DSI, EIC, c00100, e00300, e00400, e00600, c01000,
             c59660 = eitc
 
     if MARS == 2:
-        po_start = EITC_ps[EIC] + EITC_ps_MarriedJ[EIC]
+        po_start = EITC_ps[EIC] + EITC_ps_addon_MarriedJ[EIC]
         if not EITC_indiv:
             # filing unit EITC rather than individual EITC
             eitc = EITCamount(EITC_basic_frac,

taxcalc/calculator.py

@@ -81,7 +81,7 @@ class Calculator():
     The most efficient way to specify current-law and reform Calculator
     objects is as follows:
          pol = Policy()
-         rec = Records()
+         rec = Records.cps_constructor()
          calc1 = Calculator(policy=pol, records=rec)  # current-law
          pol.implement_reform(...)
          calc2 = Calculator(policy=pol, records=rec)  # reform

taxcalc/cli/tc.py

@@ -229,12 +229,6 @@ def cli_tc_main():
             sys.stderr.write(msg)
             sys.stderr.write('USAGE: tc --help\n')
         return 1
-    # specify if aging input data
-    aging_data = (
-        inputfn.endswith('puf.csv') or
-        inputfn.endswith('cps.csv') or
-        inputfn.endswith('tmd.csv')
-    )
     # check args.dumpdb and args.dumpvars consistency
     if not args.dumpdb and args.dumpvars:
         msg = 'ERROR: DUMPVARS file specified without --dumpdb option\n'
@@ -299,7 +293,6 @@ def cli_tc_main():
         baseline=args.baseline,
         reform=args.reform,
         assump=args.assump,
-        aging_input_data=aging_data,
         exact_calculations=args.exact,
     )
     if tcio.errmsg:
@@ -346,7 +339,7 @@ def cli_tc_main():
         return 0
     # analyze years after taxyear if args.numyears is greater than one
     for xyear in range(1, args.numyears):
-        tcio.advance_to_year(taxyear + xyear, aging_data)
+        tcio.advance_to_year(taxyear + xyear)
         tcio.analyze(
             output_params=args.params,
             output_tables=args.tables,

taxcalc/data.py

@@ -236,8 +236,7 @@ class Data():
                 self.IGNORED_VARS.add(varname)
         # check that MUST_READ_VARS are all present in taxdf
         if not self.MUST_READ_VARS.issubset(READ_VARS):
-            msg = 'data missing one or more MUST_READ_VARS'
-            raise ValueError(msg)
+            raise ValueError('data missing one or more MUST_READ_VARS')
         # delete intermediate taxdf object
         del taxdf
         # create other class variables that are set to all zeros

taxcalc/policy.py

@@ -7,7 +7,6 @@ Tax-Calculator federal tax policy Policy class.
 
 import os
 import json
-from pathlib import Path
 import paramtools
 from taxcalc.parameters import Parameters
 from taxcalc.growfactors import GrowFactors
@@ -56,8 +55,7 @@ class Policy(Parameters):
         return last_budget_year - Policy.JSON_START_YEAR + 1
 
     # NOTE: the following three data structures use internal parameter names:
-    # (1) specify which Policy parameters have been removed or renamed recently
-    #     where "recently" means in the last major release
+    # (1) specify which Policy parameters have been removed or renamed
     REMOVED_PARAMS = {
         # following parameters were renamed in PR 2918
         'SS_thd50': 'was renamed SS_thd1 in Tax-Calculator 5.0.0',
@@ -111,9 +109,13 @@ class Policy(Parameters):
         'ID_reduction_other_rate': (
             'was renamed ID_reduction_rate in Tax-Calculator 5.1.0'
         ),
+        # following parameters were renamed in PR 2965
+        'AMT_rt2': 'was renamed AMT_rt2_addon in Tax-Calculator 6.1.0',
+        'EITC_ps_MarriedJ': (
+            'was renamed EITC_ps_addon_MarriedJ in Tax-Calculator 6.1.0'
+        ),
     }
-    # (2) specify which Policy parameters have been redefined recently
-    #     where "recently" means in the last major release
+    # (2) specify which Policy parameters have been redefined
     REDEFINED_PARAMS = {}
     # (3) specify which Policy parameters are wage (rather than price) indexed
     WAGE_INDEXED_PARAMS = ['SS_Earnings_c', 'SS_Earnings_thd']
@@ -141,23 +143,6 @@ class Policy(Parameters):
                         Policy.REDEFINED_PARAMS,
                         Policy.WAGE_INDEXED_PARAMS, **kwargs)
 
-    @staticmethod
-    def tmd_constructor(
-            growfactors: Path | GrowFactors,
-            last_budget_year=LAST_BUDGET_YEAR,
-    ):  # pragma: no cover
-        """
-        Static method returns a Policy object instantiated with TMD
-        input data.  This convenience method works in a analogous way
-        to Policy(), which returns a Policy object instantiated with
-        non-TMD input data.
-        """
-        if isinstance(growfactors, Path):
-            growfactors = GrowFactors(growfactors_filename=str(growfactors))
-        else:
-            assert isinstance(growfactors, GrowFactors)
-        return Policy(gfactors=growfactors, last_budget_year=last_budget_year)
-
     @staticmethod
     def read_json_reform(obj):
         """

taxcalc/policy_current_law.json

@@ -17502,9 +17502,9 @@
             "cps": true
         }
     },
-    "AMT_rt2": {
+    "AMT_rt2_addon": {
         "title": "Additional AMT rate for AMT taxable income above AMT bracket 1",
-        "description": "The additional tax rate applied to the portion of AMT income above the AMT bracket 1.",
+        "description": "The additional tax rate applied to the portion of AMT income above the AMT bracket 1, which means that AMT_rt2_addon equals AMT_rt2 minus AMT_rt1.",
         "notes": "This is the additional tax rate (on top of AMT rate 1) for AMT income above AMT bracket 1.",
         "section_1": "Personal Income",
         "section_2": "Alternative Minimum Tax",
@@ -17519,8 +17519,8 @@
         ],
         "validators": {
             "range": {
-                "min": 0,
-                "max": 1
+                "min": 0.0,
+                "max": 0.1
             }
         },
         "compatible_data": {
@@ -19734,9 +19734,9 @@
             "cps": true
         }
     },
-    "EITC_ps_MarriedJ": {
+    "EITC_ps_addon_MarriedJ": {
         "title": "Extra earned income credit phaseout start AGI for married filling jointly",
-        "description": "This is the additional amount added on the regular phaseout start amount for taxpayers with filling status of married filing jointly.",
+        "description": "This is the additional amount added on the regular phaseout start amount for taxpayers with filling status of married filing jointly, which means that EITC_ps_addon_MarriedJ equals EITC_ps_MarriedJ minus EITC_ps.",
         "notes": "",
         "section_1": "Refundable Credits",
         "section_2": "Earned Income Tax Credit",

taxcalc/records.py

@@ -23,10 +23,10 @@ class Records(Data):
 
     Parameters
     ----------
-    data: string or Pandas DataFrame
+    data: string or Pandas DataFrame or None
         string describes CSV file in which records data reside;
         DataFrame already contains records data;
-        default value is the string 'puf.csv'
+        default value is None.
         NOTE: when using custom data, set this argument to a DataFrame.
         NOTE: to use your own data for a specific year with Tax-Calculator,
         be sure to read the documentation on creating your own data file and
@@ -37,29 +37,28 @@ class Records(Data):
         NOTE: data=None is allowed but the returned instance contains only
               the data variable information in the specified VARINFO file.
 
-    start_year: integer
+    start_year: integer or None
         specifies calendar year of the input data;
-        default value is PUFCSV_YEAR.
+    default value is None.
         Note that if specifying your own data (see above NOTE) as being
         a custom data set, be sure to explicitly set start_year to the
         custom data's calendar year.
 
     gfactors: GrowFactors class instance or None
         containing record data growth (or extrapolation) factors.
+        default value is None.
 
-    weights: string or Pandas DataFrame or None
-        string describes CSV file in which weights reside;
-        DataFrame already contains weights;
-        None creates empty sample-weights DataFrame;
-        default value is filename of the PUF weights.
+    weights: Pandas DataFrame or None
+        DataFrame contains data weights;
+        None creates empty weights DataFrame;
+        default value is None
         NOTE: when using custom weights, set this argument to a DataFrame.
         NOTE: see weights_scale documentation below.
 
-    adjust_ratios: string or Pandas DataFrame or None
-        string describes CSV file in which adjustment ratios reside;
-        DataFrame already contains transposed/no-index adjustment ratios;
+    adjust_ratios: Pandas DataFrame or None
+        DataFrame contains transposed/no-index adjustment ratios;
         None creates empty adjustment-ratios DataFrame;
-        default value is filename of the PUF adjustment ratios.
+        default value is None.
         NOTE: when using custom ratios, set this argument to a DataFrame.
         NOTE: if specifying a DataFrame, set adjust_ratios to my_df defined as:
               my_df = pd.read_csv('<my_ratios.csv>', index_col=0).transpose()
@@ -75,6 +74,7 @@ class Records(Data):
         generated in the taxdata repository use a weights_scale of 0.01,
         while TMD input data generated in the tax-microdata repository
         use a 1.0 weights_scale value.
+        default value is 0.01.
 
     Raises
     ------
@@ -92,20 +92,12 @@ class Records(Data):
 
     Notes
     -----
-    Typical usage when using PUF input data is as follows::
-
-        recs = Records()
-
-    which uses all the default parameters of the constructor, and
-    therefore, imputed variables are generated to augment the data and
-    initial-year grow factors are applied to the data.  There are
-    situations in which you need to specify the values of the Record
-    constructor's arguments, but be sure you know exactly what you are
-    doing when attempting this.
-
     Use Records.cps_constructor() to get a Records object instantiated
     with CPS input data developed in the taxdata repository.
 
+    Use Records.puf_constructor() to get a Records object instantiated
+    with PUF input data developed in the taxdata repository.
+
     Use Records.tmd_constructor() to get a Records object instantiated
     with TMD input data developed in the tax-microdata repository.
     """
@@ -120,20 +112,16 @@ class Records(Data):
     CPSCSV_YEAR = 2014
     TMDCSV_YEAR = 2021
 
-    PUF_WEIGHTS_FILENAME = 'puf_weights.csv.gz'
-    PUF_RATIOS_FILENAME = 'puf_ratios.csv'
-    CPS_WEIGHTS_FILENAME = 'cps_weights.csv.gz'
-    CPS_RATIOS_FILENAME = None
     CODE_PATH = os.path.abspath(os.path.dirname(__file__))
     VARINFO_FILE_NAME = 'records_variables.json'
     VARINFO_FILE_PATH = CODE_PATH
 
     def __init__(self,
-                 data='puf.csv',
-                 start_year=PUFCSV_YEAR,
-                 gfactors=GrowFactors(),
-                 weights=PUF_WEIGHTS_FILENAME,
-                 adjust_ratios=PUF_RATIOS_FILENAME,
+                 data=None,
+                 start_year=None,
+                 gfactors=None,
+                 weights=None,
+                 adjust_ratios=None,
                  exact_calculations=False,
                  weights_scale=0.01):
         # pylint: disable=too-many-positional-arguments
@@ -205,32 +193,58 @@ class Records(Data):
             raise ValueError('not all PT_SSTB_income values are 0 or 1')
 
     @staticmethod
-    def cps_constructor(data=None,
-                        gfactors=GrowFactors(),
-                        exact_calculations=False):
+    def cps_constructor(
+            data=None,
+            gfactors=GrowFactors(),
+            exact_calculations=False
+    ):
         """
         Static method returns a Records object instantiated with CPS
-        input data.  This works in a analogous way to Records(), which
-        returns a Records object instantiated with PUF input data.
-        This is a convenience method that eliminates the need to
-        specify all the details of the CPS input data just as the
-        default values of the arguments of the Records class constructor
-        eliminate the need to specify all the details of the PUF input
-        data.
+        input data.  This is a convenience method that eliminates the
+        need to specify all the details of the CPS input data.
         """
         if data is None:
             data = os.path.join(Records.CODE_PATH, 'cps.csv.gz')
         if gfactors is None:
             weights = None
         else:
-            weights = os.path.join(Records.CODE_PATH,
-                                   Records.CPS_WEIGHTS_FILENAME)
-        return Records(data=data,
-                       start_year=Records.CPSCSV_YEAR,
-                       gfactors=gfactors,
-                       weights=weights,
-                       adjust_ratios=Records.CPS_RATIOS_FILENAME,
-                       exact_calculations=exact_calculations)
+            weights = os.path.join(Records.CODE_PATH, 'cps_weights.csv.gz')
+        return Records(
+            data=data,
+            start_year=Records.CPSCSV_YEAR,
+            gfactors=gfactors,
+            weights=weights,
+            adjust_ratios=None,
+            exact_calculations=exact_calculations,
+            weights_scale=0.01,
+        )
+
+    @staticmethod
+    def puf_constructor(
+            data='puf.csv',
+            gfactors=GrowFactors(),
+            weights='puf_weights.csv.gz',
+            ratios='puf_ratios.csv',
+            exact_calculations=False
+    ):  # pragma: no cover
+        """
+        Static method returns a Records object instantiated with PUF
+        input data.  This is a convenience method that eliminates the
+        need to specify all the details of the PUF input data.
+        """
+        assert isinstance(data, str)
+        assert isinstance(gfactors, GrowFactors)
+        assert isinstance(weights, str)
+        assert isinstance(ratios, str)
+        return Records(
+            data=pd.read_csv(data),
+            start_year=Records.PUFCSV_YEAR,
+            gfactors=gfactors,
+            weights=pd.read_csv(weights),
+            adjust_ratios=pd.read_csv(ratios, index_col=0).transpose(),
+            exact_calculations=exact_calculations,
+            weights_scale=0.01,
+        )
 
     @staticmethod
     def tmd_constructor(
@@ -241,13 +255,8 @@ class Records(Data):
     ):  # pragma: no cover
         """
         Static method returns a Records object instantiated with TMD
-        input data.  This works in a analogous way to Records(), which
-        returns a Records object instantiated with PUF input data.
-        This is a convenience method that eliminates the need to
-        specify all the details of the TMD input data just as the
-        default values of the arguments of the Records class constructor
-        eliminate the need to specify all the details of the PUF input
-        data.
+        input data.  This is a convenience method that eliminates the
+        need to specify all the details of the TMD input data.
         """
         assert isinstance(data_path, Path)
         assert isinstance(weights_path, Path)
@@ -395,42 +404,29 @@ class Records(Data):
 
     def _adjust(self, year):
         """
-        Adjust value of income variables to match SOI distributions
+        Adjust value of PUF income variables to match SOI distributions
         Note: adjustment must leave variables as numpy.ndarray type
         """
         # pylint: disable=no-member
-        if self.ADJ.size > 0:
+        if self.ADJ.size > 0:  # pragma: no cover
             # Interest income
             self.e00300 *= self.ADJ[f'INT{year}'].iloc[self.agi_bin].values
 
     def _read_ratios(self, ratios):
         """
-        Read Records adjustment ratios from file or
-        use specified transposed/no-index DataFrame as ratios or
-        create empty DataFrame if None
+        Read Records PUF-related adjustment ratios using
+        specified transposed/no-index DataFrame as ratios or
+        create empty DataFrame if ratios is None.
         """
+        assert ratios is None or isinstance(ratios, pd.DataFrame)
         if ratios is None:
             setattr(self, 'ADJ', pd.DataFrame({'nothing': []}))
             return
-        if isinstance(ratios, pd.DataFrame):
+        if isinstance(ratios, pd.DataFrame):  # pragma: no cover
             assert 'INT2013' in ratios.columns  # check for transposed
             assert ratios.index.name is None  # check for no-index
             ADJ = ratios
-        elif isinstance(ratios, str):
-            ratios_path = os.path.join(Records.CODE_PATH, ratios)
-            if os.path.isfile(ratios_path):
-                ADJ = pd.read_csv(ratios_path,
-                                  index_col=0)
-            else:  # find file in conda package
-                ADJ = read_egg_csv(os.path.basename(ratios_path),
-                                   index_col=0)  # pragma: no cover
-            ADJ = ADJ.transpose()
-        else:
-            msg = 'ratios is neither None nor a Pandas DataFrame nor a string'
-            raise ValueError(msg)
-        assert isinstance(ADJ, pd.DataFrame)
-        if ADJ.index.name != 'agi_bin':
-            ADJ.index.name = 'agi_bin'
-        self.ADJ = pd.DataFrame()
-        setattr(self, 'ADJ', ADJ.astype(np.float32))
-        del ADJ
+            self.ADJ = pd.DataFrame()
+            if ADJ.index.name != 'agi_bin':
+                ADJ.index.name = 'agi_bin'
+            setattr(self, 'ADJ', ADJ.astype(np.float32))