Make last budget year flexible

conda.recipe/meta.yaml

@@ -9,22 +9,24 @@ build:
 requirements:
   build:
     - "python>=3.10, <3.13"
-    - "numpy>=1.26,<1.27"
+    - "numpy>=1.26"
     - "pandas>=2.2"
     - "bokeh>=2.4"
-    - "paramtools>=0.18.3"
+    - "paramtools>=0.19.0"
     - numba
+    - requests
     - curl
     - openpyxl
     - behresp
 
   run:
     - "python>=3.10, <3.13"
-    - "numpy>=1.26,<1.27"
+    - "numpy>=1.26"
     - "pandas>=2.2"
     - "bokeh>=2.4"
-    - "paramtools>=0.18.3"
+    - "paramtools>=0.19.0"
     - numba
+    - requests
     - curl
     - openpyxl
     - behresp

environment.yml

@@ -3,11 +3,13 @@ channels:
   - conda-forge
 dependencies:
 - "python>=3.10, <3.13"
-- "numpy>=1.26,<1.27"
+- "numpy>=1.26"
 - "pandas>=2.2"
 - "bokeh>=2.4"
 - numba
+- requests
 - curl
+- setuptools
 - pytest
 - pytest-xdist
 - pycodestyle
@@ -18,4 +20,4 @@ dependencies:
 - pip
 - pip:
     - jupyter-book
-    - "paramtools>=0.18.3"
+    - "paramtools>=0.19.0"

setup.py

@@ -18,13 +18,12 @@
     "include_package_data": True,
     "name": "taxcalc",
     "install_requires": [
-        "setuptools",
-        "numpy",
-        "pandas",
-        "bokeh",
+        "numpy>=1.26",
+        "pandas>=2.2",
+        "bokeh>=2.4",
         "numba",
         "requests",
-        "paramtools>=0.18.3",
+        "paramtools>=0.19.0",
     ],
     "classifiers": [
         "Development Status :: 4 - Beta",

taxcalc.egg-info/PKG-INFO

@@ -18,13 +18,12 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: setuptools
-Requires-Dist: numpy
-Requires-Dist: pandas
-Requires-Dist: bokeh
+Requires-Dist: numpy>=1.26
+Requires-Dist: pandas>=2.2
+Requires-Dist: bokeh>=2.4
 Requires-Dist: numba
 Requires-Dist: requests
-Requires-Dist: paramtools>=0.18.3
+Requires-Dist: paramtools>=0.19.0
 
 | | |
 | --- | --- |

taxcalc.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ pyproject.toml
 pytest.ini
 setup.py
 tctest-nojit.sh
+update_pcl.py
 .github/FUNDING.yml
 .github/workflows/build_and_test.yml
 .github/workflows/check_jupyterbook.yml
@@ -172,6 +173,8 @@ taxcalc/reforms/ptaxes2.json
 taxcalc/reforms/ptaxes2.out.csv
 taxcalc/reforms/ptaxes3.json
 taxcalc/reforms/ptaxes3.out.csv
+taxcalc/reforms/rounding.json
+taxcalc/reforms/rounding.out.csv
 taxcalc/reforms/archive/Clinton2016.json
 taxcalc/reforms/archive/RyanBrady.json
 taxcalc/reforms/archive/TCJA_House.json
@@ -238,4 +241,6 @@ taxcalc/validation/taxsim35/expected_differences/b20-taxdiffs-expect.csv
 taxcalc/validation/taxsim35/expected_differences/b21-taxdiffs-expect.csv
 taxcalc/validation/taxsim35/expected_differences/c17-taxdiffs-expect.csv
 taxcalc/validation/taxsim35/expected_differences/c18-taxdiffs-expect.csv
-taxcalc/validation/taxsim35/expected_differences/c19-taxdiffs-expect.csv
+taxcalc/validation/taxsim35/expected_differences/c19-taxdiffs-expect.csv
+taxcalc/validation/taxsim35/expected_differences/c20-taxdiffs-expect.csv
+taxcalc/validation/taxsim35/expected_differences/c21-taxdiffs-expect.csv

taxcalc.egg-info/requires.txt

@@ -1,7 +1,6 @@
-setuptools
-numpy
-pandas
-bokeh
+numpy>=1.26
+pandas>=2.2
+bokeh>=2.4
 numba
 requests
-paramtools>=0.18.3
+paramtools>=0.19.0

taxcalc/calculator.py

@@ -105,7 +105,8 @@ def __init__(self, policy=None, records=None, verbose=False,
         if self.__policy.current_year < self.__records.data_year:
             self.__policy.set_year(self.__records.data_year)
         if consumption is None:
-            self.__consumption = Consumption()
+            print("CONS policy num years = ", policy.NUM_YEARS)
+            self.__consumption = Consumption(policy.NUM_YEARS)
         elif isinstance(consumption, Consumption):
             self.__consumption = copy.deepcopy(consumption)
         else:

taxcalc/cli/tc.py

@@ -27,6 +27,8 @@ def cli_tc_main():
     # parse command-line arguments:
     usage_str = 'tc INPUT TAXYEAR {}{}{}{}{}'.format(
         '[--help]\n',
+        ('          '
+         '[--budgetend BUDGETENDYEAR]\n'),
         ('          '
          '[--baseline BASELINE] [--reform REFORM] [--assump  ASSUMP]\n'),
         ('          '
@@ -56,6 +58,15 @@ def cli_tc_main():
                               'are computed.'),
                         type=int,
                         default=0)
+    parser.add_argument('--budgetend',
+                        help=('BUDGETENDYEAR is name of optional '
+                              'calendar year that is the last year '
+                              'of the budget window to be analyzed. '
+                              'No --budget implies the budget window '
+                              'extends until '
+                              'Policy.DEFAULT_LAST_BUDGET_YEAR.'),
+                        type=int,
+                        default=None)
     parser.add_argument('--baseline',
                         help=('BASELINE is name of optional JSON reform file. '
                               'No --baseline implies baseline policy is '
@@ -164,6 +175,7 @@ def cli_tc_main():
         taxyear = args.TAXYEAR
     # instantiate TaxCalcIO object and do tax analysis
     tcio = tc.TaxCalcIO(input_data=inputfn, tax_year=taxyear,
+                        budget_end_year=args.budgetend,
                         baseline=args.baseline,
                         reform=args.reform, assump=args.assump,
                         outdir=args.outdir)
@@ -179,6 +191,7 @@ def cli_tc_main():
     if args.timings:
         stime = time.time()
     tcio.init(input_data=inputfn, tax_year=taxyear,
+              budget_end_year=args.budgetend,
               baseline=args.baseline,
               reform=args.reform, assump=args.assump,
               aging_input_data=aging,

taxcalc/consumption.py

@@ -28,14 +28,16 @@ class instance: Consumption
     """
 
     JSON_START_YEAR = Policy.JSON_START_YEAR
-    DEFAULT_NUM_YEARS = Policy.DEFAULT_NUM_YEARS
+    NUM_YEARS = Policy.NUM_YEARS
     DEFAULTS_FILE_NAME = 'consumption.json'
     DEFAULTS_FILE_PATH = os.path.abspath(os.path.dirname(__file__))
 
-    def __init__(self):
+    def __init__(self, nyrs=NUM_YEARS):
+        # put JSON contents of DEFAULTS_FILE_NAME into self._vals dictionary
         super().__init__()
+        print("CONS policy num years = ", nyrs)
         self.initialize(Consumption.JSON_START_YEAR,
-                        Consumption.DEFAULT_NUM_YEARS)
+                        nyrs)
 
     @staticmethod
     def read_json_update(obj):

taxcalc/growdiff.py

@@ -28,14 +28,13 @@ class instance: GrowDiff
     """
 
     JSON_START_YEAR = Policy.JSON_START_YEAR
-    DEFAULT_NUM_YEARS = Policy.DEFAULT_NUM_YEARS
+    NUM_YEARS = Policy.NUM_YEARS
     DEFAULTS_FILE_NAME = 'growdiff.json'
     DEFAULTS_FILE_PATH = os.path.abspath(os.path.dirname(__file__))
 
-    def __init__(self):
-        super().__init__()
+    def __init__(self, nyrs=NUM_YEARS):
         self.initialize(GrowDiff.JSON_START_YEAR,
-                        GrowDiff.DEFAULT_NUM_YEARS)
+                        nyrs)
 
     @staticmethod
     def read_json_update(obj, topkey):

taxcalc/growfactors.py

@@ -84,6 +84,7 @@ def __init__(self, growfactors_filename=None):
         # determine first_year and last_year from gfdf
         self._first_year = min(gfdf.index)
         self._last_year = max(gfdf.index)
+        print("IN Gfactors last year is ", self._last_year)
         # set gfdf as attribute of class
         self.gfdf = pd.DataFrame()
         setattr(self, 'gfdf', gfdf.astype(np.float64))

taxcalc/parameters.py

@@ -99,6 +99,7 @@ def __init__(self, start_year=None, num_years=None, last_known_year=None,
                 self.DEFAULTS_FILE_NAME
             )
 
+        self.LAST_BUDGET_YEAR = start_year + num_years - 1
         if last_known_year is None:
             self._last_known_year = start_year
         else:
@@ -118,6 +119,10 @@ def __init__(self, start_year=None, num_years=None, last_known_year=None,
             kwargs["initial_state"] = {
                 "year": start_year or self.JSON_START_YEAR
             }
+        # Update defaults to user defined budget window
+        self.defaults = super().get_defaults()
+        label = self.defaults["schema"]["labels"]["year"]
+        label["validators"]["range"]["max"] = self.LAST_BUDGET_YEAR
         super().__init__(**kwargs)
 
     def adjust(
@@ -817,4 +822,4 @@ def is_paramtools_format(params: Union[TaxcalcReform, ParamToolsAdjustment]):
         else:
             # Not doing a specific check to see if the value is a list
             # since it could be a list or just a scalar value.
-            return True
+            return True

taxcalc/policy.py

@@ -39,9 +39,8 @@ class instance: Policy
     JSON_START_YEAR = 2013  # remains the same unless earlier data added
     LAST_KNOWN_YEAR = 2025  # 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
-    DEFAULT_NUM_YEARS = LAST_BUDGET_YEAR - JSON_START_YEAR + 1
+    DEFAULT_LAST_BUDGET_YEAR = 2034  # last extrapolation year
+    NUM_YEARS = DEFAULT_LAST_BUDGET_YEAR - JSON_START_YEAR + 1
 
     # NOTE: the following three data structures use internal parameter names:
     # (1) specify which Policy parameters have been removed or renamed
@@ -80,7 +79,9 @@ class instance: Policy
     # (3) specify which Policy parameters are wage (rather than price) indexed
     WAGE_INDEXED_PARAMS = ['SS_Earnings_c', 'SS_Earnings_thd']
 
-    def __init__(self, gfactors=None, **kwargs):
+    def __init__(self, gfactors=None,
+                 last_budget_year=DEFAULT_LAST_BUDGET_YEAR,
+                 **kwargs):
         # put JSON contents of DEFAULTS_FILE_NAME into self._vals dictionary
         super().__init__()
         # handle gfactors argument
@@ -92,7 +93,8 @@ def __init__(self, gfactors=None, **kwargs):
             raise ValueError('gfactors is not None or a GrowFactors instance')
         # read default parameters and initialize
         syr = Policy.JSON_START_YEAR
-        nyrs = Policy.DEFAULT_NUM_YEARS
+        nyrs = last_budget_year - syr + 1
+        Policy.NUM_YEARS = nyrs
         self._inflation_rates = None
         self._wage_growth_rates = None
         self.initialize(syr, nyrs, Policy.LAST_KNOWN_YEAR,
@@ -101,7 +103,8 @@ def __init__(self, gfactors=None, **kwargs):
                         Policy.WAGE_INDEXED_PARAMS, **kwargs)
 
     @staticmethod
-    def tmd_constructor(growfactors: Path | GrowFactors):  # pragma: no cover
+    def tmd_constructor(growfactors: Path | GrowFactors,
+                        last_budget_year=DEFAULT_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
@@ -112,7 +115,8 @@ def tmd_constructor(growfactors: Path | GrowFactors):  # pragma: no cover
             growfactors = GrowFactors(growfactors_filename=str(growfactors))
         else:
             assert isinstance(growfactors, GrowFactors)
-        return Policy(gfactors=growfactors)
+        return Policy(gfactors=growfactors,
+                      last_budget_year=last_budget_year)
 
     @staticmethod
     def read_json_reform(obj):

taxcalc/taxcalcio.py

@@ -35,12 +35,16 @@ class TaxCalcIO():
         string is name of INPUT file that is CSV formatted containing
         variable names in the Records USABLE_READ_VARS set, or
         Pandas DataFrame is INPUT data containing variable names in
-        the Records USABLE_READ_VARS set.  INPUT vsrisbles not in the
+        the Records USABLE_READ_VARS set.  INPUT variables not in the
         Records USABLE_READ_VARS set can be present but are ignored.
 
     tax_year: integer
         calendar year for which taxes will be computed for INPUT.
 
+    budget_end_year: integer
+        last calendar year in the budget window for which taxes will
+        be computed for INPUT.
+
     baseline: None or string
         None implies baseline policy is current-law policy, or
         string is name of optional BASELINE file that is a JSON
@@ -64,8 +68,8 @@ class instance: TaxCalcIO
     """
     # pylint: disable=too-many-instance-attributes
 
-    def __init__(self, input_data, tax_year, baseline, reform, assump,
-                 outdir=None):
+    def __init__(self, input_data, tax_year, budget_end_year, baseline,
+                 reform, assump, outdir=None):
         # pylint: disable=too-many-arguments,too-many-locals
         # pylint: disable=too-many-branches,too-many-statements
         self.gf_reform = None
@@ -228,8 +232,8 @@ def __init__(self, input_data, tax_year, baseline, reform, assump,
         self.param_dict = None
         self.policy_dicts = []
 
-    def init(self, input_data, tax_year, baseline, reform, assump,
-             aging_input_data, exact_calculations):
+    def init(self, input_data, tax_year, budget_end_year, baseline,
+             reform, assump, aging_input_data, exact_calculations):
         """
         TaxCalcIO class post-constructor method that completes initialization.
 
@@ -253,6 +257,11 @@ def init(self, input_data, tax_year, baseline, reform, assump,
         basedict = Calculator.read_json_param_objects(baseline, None)
         # get assumption sub-dictionaries
         paramdict = Calculator.read_json_param_objects(None, assump)
+        # Set budget window end year
+        if budget_end_year is None:
+            budget_end_year = Policy.DEFAULT_LAST_BUDGET_YEAR
+        else:
+            Policy.DEFAULT_LAST_BUDGET_YEAR = budget_end_year
         # get policy parameter dictionaries from --reform file(s)
         policydicts = []
         if self.specified_reform:
@@ -292,7 +301,10 @@ def init(self, input_data, tax_year, baseline, reform, assump,
         self.gf_reform = copy.deepcopy(gfactors_ref)
         # create Policy objects:
         # ... the baseline Policy object
-        base = Policy(gfactors=gfactors_base)
+        print("GF BASE = ", gfactors_base.last_year, max(gfactors_base.gfdf.index))
+        print("GF BASE = ", gfactors_base.last_year)
+        base = Policy(gfactors=gfactors_base,
+                      last_budget_year=budget_end_year)
         try:
             base.implement_reform(basedict['policy'],
                                   print_warnings=True,
@@ -303,7 +315,8 @@ def init(self, input_data, tax_year, baseline, reform, assump,
             self.errmsg += valerr_msg.__str__()
         # ... the reform Policy object
         if self.specified_reform:
-            pol = Policy(gfactors=gfactors_ref)
+            pol = Policy(gfactors=gfactors_ref,
+                         last_budget_year=budget_end_year)
             for poldict in policydicts:
                 try:
                     pol.implement_reform(poldict,
@@ -316,7 +329,8 @@ def init(self, input_data, tax_year, baseline, reform, assump,
                 except paramtools.ValidationError as valerr_msg:
                     self.errmsg += valerr_msg.__str__()
         else:
-            pol = Policy(gfactors=gfactors_base)
+            pol = Policy(gfactors=gfactors_base,
+                         last_budget_year=budget_end_year)
         # create Consumption object
         con = Consumption()
         try:
@@ -393,6 +407,7 @@ def init(self, input_data, tax_year, baseline, reform, assump,
             msg = msg.format(tax_year, recs.data_year)
             self.errmsg += 'ERROR: {}\n'.format(msg)
         # create Calculator objects
+        print("POLICY YEAR = ", pol.DEFAULT_LAST_BUDGET_YEAR)
         self.calc = Calculator(policy=pol, records=recs,
                                verbose=True,
                                consumption=con,