taxcalc 5.3.0__tar.gz → 6.0.0__tar.gz

{taxcalc-5.3.0 → taxcalc-6.0.0}/.github/workflows/build_and_test.yml

@@ -35,7 +35,7 @@ jobs:
         shell: bash -l {0}
         working-directory: ./
         run: |
-          pytest -m 'not requires_pufcsv and not pre_release and not local' --cov=./ --cov-report=xml
+          pytest -m 'not requires_puf and not requires_tmd and not local' --cov=./ --cov-report=xml
 
       - name: Upload coverage to Codecov
         if: matrix.os == 'ubuntu-latest' && contains(github.repository, 'PSLmodels/Tax-Calculator')

{taxcalc-5.3.0 → taxcalc-6.0.0}/.gitignore

@@ -13,9 +13,11 @@ read-the-docs/_build/
 # Mac OS X
 *.DS_Store
 
-# IRS-SOI PUF data file
-puf.csv
-tmd.csv
+# Non-public IRS-SOI PUF and TMD data files
+puf*csv*
+puf*zip
+*tmd*csv*
+tmd*zip
 
 # Jupyter notebook checkpoints
 *.ipynb_checkpoints*

{taxcalc-5.3.0 → taxcalc-6.0.0}/MANIFEST.in

@@ -4,6 +4,4 @@ include taxcalc/cps_weights.csv.gz
 include taxcalc/growdiff.json
 include taxcalc/growfactors.csv
 include taxcalc/policy_current_law.json
-include taxcalc/puf_weights.csv.gz
-include taxcalc/puf_ratios.csv
 include taxcalc/records_variables.json

{taxcalc-5.3.0 → taxcalc-6.0.0}/Makefile

@@ -12,10 +12,8 @@ help:
 	@echo "help       : show help message"
 	@echo "clean      : remove .pyc files and local taxcalc package"
 	@echo "package    : build and install local package"
-	@echo "pytest-cps : generate report for and cleanup after"
-	@echo "             pytest -m 'not requires_pufcsv and not pre_release'"
 	@echo "pytest     : generate report for and cleanup after"
-	@echo "             pytest -m 'not pre_release'"
+	@echo "             pytest -m 'not requires_puf and not requires_tmd'"
 	@echo "pytest-all : generate report for and cleanup after"
 	@echo "             pytest -m ''"
 	@echo "tctest     : generate report for and cleanup after"
@@ -24,6 +22,8 @@ help:
 	@echo "             tc --test when environment var NOTAXCALCJIT is set"
 	@echo "cstest     : generate coding-style errors using the"
 	@echo "             pycodestyle (nee pep8) and pylint tools"
+	@echo "idtest     : generate report for and cleanup after executing"
+	@echo "             taxcalc/cli/input_data_tests/tests.sh"
 	@echo "coverage   : generate test coverage report"
 	@echo "git-sync   : synchronize local, origin, and upstream Git repos"
 	@echo "git-pr N=n : create local pr-n branch containing upstream PR"
@@ -36,7 +36,7 @@ clean:
 
 .PHONY=package
 package:
-	@pip install -e .
+	@pip install -e . | tail -1
 
 define pytest-setup
 rm -f taxcalc/tests/reforms_actual_init
@@ -48,19 +48,13 @@ rm -f df-??-#-*
 rm -f tmp??????-??-#-tmp*
 endef
 
-.PHONY=pytest-cps
-pytest-cps: clean
-	@$(pytest-setup)
-	@cd taxcalc ; pytest -n4 --disable-warnings --durations=0 --durations-min=2 -m "not requires_pufcsv and not pre_release"
-	@$(pytest-cleanup)
-
 .PHONY=pytest
 pytest: clean
 	@$(pytest-setup)
-	@cd taxcalc ; pytest -n4 --disable-warnings --durations=0 --durations-min=2 -m "not pre_release"
+	@cd taxcalc ; pytest -n4 --disable-warnings --durations=0 --durations-min=2 -m "not requires_puf and not requires_tmd"
 	@$(pytest-cleanup)
 
-.PHONY=pytest-all
+.PHONY=pytest
 pytest-all: clean
 	@$(pytest-setup)
 	@cd taxcalc ; pytest -n4 --disable-warnings --durations=0 --durations-min=2 -m ""
@@ -97,11 +91,16 @@ cstest:
 	@-pycodestyle --ignore=E501,E121 $(TESTS_JSON_FILES)
 	@-pylint $(PYLINT_OPTIONS) --ignore-paths=$(EXCLUDED_PATHS) .
 
+.PHONY=idtest
+idtest: package
+	@echo "Executing taxcalc/cli/input_data_tests"
+	@cd taxcalc/cli/input_data_tests ; ./tests.sh
+
 define coverage-cleanup
 rm -f .coverage htmlcov/*
 endef
 
-COVMARK = "not requires_pufcsv and not pre_release"
+COVMARK = "not requires_puf and not requires_tmd"
 
 OS := $(shell uname -s)
 

{taxcalc-5.3.0/taxcalc.egg-info → taxcalc-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: taxcalc
-Version: 5.3.0
+Version: 6.0.0
 Summary: Tax-Calculator
 Home-page: https://github.com/PSLmodels/Tax-Calculator
 Download-URL: https://github.com/PSLmodels/Tax-Calculator

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/about/releases.md

@@ -3,6 +3,19 @@ Release history
 Go [here](https://github.com/PSLmodels/Tax-Calculator/pulls?q=is%3Apr+is%3Aclosed)
 for a complete commit history.
 
+2025-09-24 Release 6.0.0
+------------------------
+(last merged pull request is
+[#2961](https://github.com/PSLmodels/Tax-Calculator/pull/2961))
+
+**This is a major release with changes that make Tax-Calculator incompatible with earlier releases.**
+
+**API Changes**
+- Removes the taxdata-produced `puf_weights.csv.gz` and `puf_ratios.csv` files. Adds a new `Records.puf_constructor` method for use with PUF data. Users will need to supply their own weights and growfactors files for the PUF as they are no longer included in Tax-Calculator. [[#2961](https://github.com/PSLmodels/Tax-Calculator/pull/2961) by Martin Holmer]
+
+**New Features**
+
+
 2025-09-19 Release 5.3.0
 ------------------------
 (last merged pull request is

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/contributing/RELEASING.md

@@ -22,7 +22,9 @@ In the top-level Tax-Calculator directory, do the following:
 
 --> run `make cstest`  [to confirm project coding style is being followed]
 
---> run `make pytest-all`  [or `pytest -m pre_release -n4` in taxcalc subdir]
+--> run `make pytest-all`  [to confirm all pytest test are passing]
+
+--> run `make idtest`  [to check CLI results for CPS, PUF, TMD input data]
 
 --> run `make tctest-jit`  [to make sure JIT decorators are not hiding bugs]
 

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/contributing/contributor_guide.md

@@ -115,11 +115,11 @@ page](https://github.com).
     the command line in the Tax-Calculator directory:
     ```
     cd taxcalc
-    pytest -m "not requires_pufcsv and not pre_release" -n4
+    pytest -m "not requires_puf and not requires_tmd" -n4
     ```
-    If you do have a copy of the `puf.csv` file used by Tax-Calculator,
-    then on the second line above omit the `not requires_pufcsv and`
-    expression so as to execute `pytest -m "not pre_release" -n4`.
+    If you do have the PUF-related files used by Tax-Calculator and
+    the TMD-related files used by Tax-Calculator, then the second line
+    above can be simplified to `pytest -n4`.
 
     If all the tests pass, you're good to go. If they don't pass, enter
     the following updates at the command line and then try running the
@@ -227,7 +227,7 @@ situations, in which case other contributors are here to help.
    from the command line in the Tax-Calculator directory:
    ```
    make cstest
-   make pytest-cps
+   make pytest
    ```
    Consult {doc}`testing` for more details.
 

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/contributing/testing.md

@@ -38,56 +38,38 @@ all these coding-style tests, proceed to the second phase of testing.
 ## Testing with pytest
 
 There are two variants of this second testing phase depending on
-whether or not you have access to a file called `puf.csv` that
-contains a representative sample of tax filing units derived from the
-IRS-SOI PUF data.
-
-A brief description of the `puf.csv` file is followed by instructions
-on how to run the two variants of the second-phase tests.
-
-The Tax-Calculator `puf.csv` file has been constructed by the core
-development team by merging information from a publicly available
-IRS-SOI PUF file for 2011 and from the Census CPS file for the
-corresponding year.  If you have acquired from IRS the 2011 SOI PUF
-file and want to execute the tests that require the `puf.csv` file,
-contact the core development team to discuss your options.
-
-**NO PUF.CSV**: If you do not have access to the `puf.csv` file (or if
-you just want to do a quick test), run the second-phase of testing as
-follows at the command prompt in the Tax-Calculator directory:
-
-```
-make pytest-cps
-```
+whether or not you have access to the PUF-related and TMD-related
+input data files.
 
-This will start executing a pytest suite containing hundreds of tests,
-but will skip the tests that require the `puf.csv` file as input and
-the tests that are executed only just before a new release is being
-prepared.
-
-**HAVE PUF.CSV**: If you do have access to the `puf.csv` file, copy it
-into the Tax-Calculator directory at the top of the repository
-directory tree (but **never** add it to your repository) and run the
-second-phase of testing as follows at the command prompt in the
-Tax-Calculator directory:
+**NO PUF AND NO TMD**: If you do not have access to the PUF or TMD
+input data files, run the second-phase of testing as follows at the
+command prompt in the Tax-Calculator directory:
 
 ```
 make pytest
 ```
 
 This will start executing a pytest suite containing hundreds of tests,
-including the tests that require the `puf.csv` file as input but
-excluding the tests that are executed only just before a new release
-is being prepared.
+but will skip the tests that require the `puf.csv` file or the `tmd.csv`
+file as input.
 
-Just before releasing a new version of Tax-Calculator or just after
-adding a new parameter to `policy_current_law.json`, you should also
-execute the pre-release tests using this command:
+**HAVE PUF AND HAVE TMD**: If you do have access to the PUF-related
+files and the TMD-related files, copy them into the Tax-Calculator
+directory at the top of the repository directory tree (but **never**
+add them to your repository) and run the second-phase of testing as
+follows at the command prompt in the Tax-Calculator directory:
 
 ```
 make pytest-all
+make idtest
 ```
 
+The first command will start executing a pytest suite containing
+hundreds of tests, including the tests that require the `puf.csv` file
+as input and the tests that require the `tmd.csv` file as input.  The
+second command checks that the Tax-Calculator CLI generates expected
+results when using the CPS, PUF, and TMD input data.
+
 ## Interpreting test results
 
 If you are adding an enhancement that expands the capabilities of the
@@ -108,9 +90,8 @@ demonstrate that the newly-added test, which used to fail, now passes.
 
 After an enhancement or bug fix, you may be convinced that the new and
 different second-phase test results are, in fact, correct.  How do you
-eliminate the test failures?  For all but the few tests that require
-the `puf.csv` file or the `cps.csv` file as input, simply edit the
-appropriate `taxcalc/tests/test_*.py` file so that the test passes
-when you rerun pytest.  If there are failures for the tests that write
-results files, read the test error message for instructions about how
-to update the test results.
+eliminate the test failures?  Simply edit the appropriate
+`taxcalc/tests/test_*.py` file so that the test passes when you rerun
+pytest.  If there are failures for the tests that write results files,
+read the test error message for instructions about how to update the
+test results.

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/index.md

@@ -54,7 +54,7 @@ cross-model validation work with NBER's TAXSIM-35 model is described
 
 ## Latest release
 
-{doc}`5.3.0 (2025-09-19) <about/releases>`
+{doc}`6.0.0 (2025-09-24) <about/releases>`
 
 If you are already using Tax-Calculator, upgrade using the following command:
 ```

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/recipes/md_src/recipe00.md

@@ -45,16 +45,7 @@ from bokeh.io import show, output_notebook
 
 ## Setup
 
-Use publicly-available CPS input file.
-
-NOTE: if you have access to the restricted-use IRS-SOI PUF-based input file
-and you have that file (named ‘puf.csv’) located in the directory
-where this script is located, then you can substitute the following
-statement for the prior statement:
-
-``
-recs = tc.Records()
-``
+Use publicly-available CPS input data included in Tax-Calculator.
 
 ```{code-cell} ipython3
 :hide-output: false

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/usage/data.md

@@ -41,21 +41,20 @@ validation of those data.
 
 The taxdata repository also produces a weights file and growth
 factors file for use with the 2011 IRS-SOI Public Use File (PUF).  For
-users who have purchased their own version of the 2011 PUF, the
-`puf_weights.csv.gz` and `growfactors.csv` files that are included in
-Tax-Calculator can be used along with the `taxdata` generated `puf.csv`
-file when using Tax-Calculator.
+users who have purchased their own version of the 2011 PUF, the `puf.csv`,
+`puf_weights.csv.gz` and `puf_ratios.csv` files from the taxdata repository,
+can be used by Tax-Calculator using the `Records.puf_constructor(...)`
+static method.
 
 We refer users of the PUF to the IRS limitations on the use of those
-data and their distribution.  We also refer users of the PUF weights
-file and grow factors to the
-[taxdata](https://github.com/PSLmodels/taxdata) documentation for
-details on how to use these files with the PUF and to see how well the
-resulting tax calculations hit aggregate targets published by the IRS.
-However, we do note that analysis with a PUF-based data file tends to
-be more accurate than the `cps.csv` file and that the validation of
-Tax-Calculator with other microsimulation models uses the `puf.csv`
-file.
+data and their distribution.  We also refer users of the PUF input
+data to the [taxdata](https://github.com/PSLmodels/taxdata)
+documentation for details on how to use these files with the PUF and
+to see how well the resulting tax calculations hit aggregate targets
+published by the IRS.  However, we do note that analysis with a
+PUF-based data file tends to be more accurate than the `cps.csv` file
+and that the validation of Tax-Calculator with other microsimulation
+models uses the `puf.csv` file.
 
 ### 2015 IRS public use data (`tmd.csv`)
 
@@ -71,9 +70,8 @@ tax-microdata repository.  The three TMD files can be used with
 Tax-Calculator in two ways:
   - with the **Python API** by instantiating a GrowFactors object that
     uses TMD growth factors [`gf=GrowFactors("path/to/tmd_growfactors.csv")`]
-    and by using the `Records.tmd_constructor()` and
-    `Policy.tmd_constructor()` static methods to instantiate a Records
-    object and a Policy object, or
+    and by using the `Records.tmd_constructor(...)` static method to
+    instantiate a Records object, or
   - with the **CLI tool**, `tc`, when the three TMD files are all in
     the same folder and the `tmd.csv.gz` file has been unzipped.
 

{taxcalc-5.3.0 → taxcalc-6.0.0}/docs/usage/overview.md

@@ -1,32 +1,32 @@
 Structural overview
 ===================
 
-Tax-Calculator has been designed using [object-oriented programming (OOP)](https://www.programiz.com/python-programming/object-oriented-programming)
-principles.
-There are seven classes and a collection of global utility functions,
-but most Python programming involves using only a few methods in three classes.
+Tax-Calculator has been designed using [object-oriented programming
+(OOP)](https://www.programiz.com/python-programming/object-oriented-programming)
+principles.  There are seven classes and a collection of global
+utility functions, but most Python programming involves using only a
+few methods in three classes.
 
 ## Quick summary
 
-Typical Tax-Calculator usage involves creating two Calculator class objects:
-both containing the same sample of filing units (that is, Records class object),
-but each containing a different tax policy (that is, Policy class object).
-The idea is to compare the calculated tax liabilities of the sample units under
-the two different tax policies,
-one of which is usually current-law policy and the other is a tax reform of
-interest.
+Typical Tax-Calculator usage involves creating two Calculator class
+objects: both containing the same sample of filing units (that is,
+Records class object), but each containing a different tax policy
+(that is, Policy class object).  The idea is to compare the calculated
+tax liabilities of the sample units under the two different tax
+policies, one of which is usually current-law policy and the other is
+a tax reform of interest.
 
 *   `rec` → Records class object.  
-    Created by `Records()` when containing IRS-SOI-PUF-derived filing-unit data
-    or created by `Records.cps_constructor()` when containing CPS-derived
-    filing-unit data.
+    Created by `Records.cps_constructor()` when containing CPS-derived
+    filing-unit data.    
 
 *   `clp` → `Policy` class object containing parameters that characterize
 current-law policy.  
     Created by `Policy()`.
 
-*   `ref` → `Policy` class object containing parameters that characterize a tax
-reform.  
+* `ref` → `Policy` class object containing parameters that
+characterize a tax reform.
     Created using a Python dictionary `refdict` representing the reform by
     using the `implement_reform(refdict)` method on a `Policy` object created
     by `Policy()`.
@@ -68,10 +68,11 @@ for Calculator class and all its methods.
 
 ## Complete story
 
-Tax-Calculator contains eight basic classes, and a collection of global utility
-functions, that together provide the full range of Tax-Calculator capabilities.
-Here is a description of their role in Tax-Calculator and a link to each the
-detailed documentation and source code for each class and all its methods.
+Tax-Calculator contains eight basic classes, and a collection of
+global utility functions, that together provide the full range of
+Tax-Calculator capabilities.  Here is a description of their role in
+Tax-Calculator and a link to each the detailed documentation and
+source code for each class and all its methods.
 
 ### Classes
 

{taxcalc-5.3.0 → taxcalc-6.0.0}/pytest.ini

@@ -2,15 +2,11 @@
 testpaths =
     taxcalc
 markers =
-    requires_pufcsv
-    pre_release
+    requires_puf
+    requires_tmd
     local
     benefits
-    compatible_data
-    cps
-    cpscsv_agg
     itmded_vars
-    pufcsv_agg
     qbid
     reforms
     rtr

{taxcalc-5.3.0 → taxcalc-6.0.0}/setup.py

@@ -7,7 +7,7 @@ from setuptools import setup
 with open("README.md", "r", encoding="utf-8") as f:
     longdesc = f.read()
 
-VERSION = "5.3.0"
+VERSION = "6.0.0"
 
 config = {
     "description": "Tax-Calculator",

{taxcalc-5.3.0 → taxcalc-6.0.0}/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.0.0'
 __min_python3_version__ = 11
 __max_python3_version__ = 13

{taxcalc-5.3.0 → taxcalc-6.0.0}/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-5.3.0 → taxcalc-6.0.0}/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-5.3.0 → taxcalc-6.0.0}/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-5.3.0 → taxcalc-6.0.0}/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
@@ -141,23 +140,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):
         """