Federal Individual Income and Payroll Tax Microsimulation Model
Python Tcl Batchfile Shell Makefile Awk
martinholmer Merge pull request #2051 from martinholmer/master
Clarify description of filer input variable
Latest commit c801447 Aug 14, 2018
Permalink
Failed to load latest commit information.
conda.recipe Revise conda.recipe/install_local_taxcalc_package.sh script Jun 4, 2018
continuous_integration Drop pep8 tests from GitHub Windows tests Apr 30, 2018
docs Update docs/index.html Aug 14, 2018
file-upload-tests Update file-upload-test results for 0.10.2 Oct 10, 2017
read-the-docs Eliminates hard-coded file lists in Makefile Jun 6, 2018
taxcalc Clarify description of filer input variable Aug 14, 2018
.coveragerc Revert .coveragerc settings Oct 20, 2017
.gitattributes add versioning with versioneer Jan 30, 2015
.gitignore Fix typo in .gitignore Jun 6, 2018
.travis.yml Still use pep8 on GitHub Apr 30, 2018
CODING.md Fix typo in CODING.md file Apr 30, 2018
DATAPREP.md Fix typos in DATAPREP.md May 4, 2017
LICENSE.md Update LICENSE.md Oct 15, 2015
MANIFEST.in Remove cps_benefits.csv.gz from MANIFEST.in file Aug 7, 2018
Makefile Broaden 'make cstest' scope and fix reforms.json format Aug 1, 2018
ODD_RECORDS.md Update output variable documentation Apr 28, 2017
README.md Update README.md info May 24, 2018
RELEASES.md Update RELEASES.md info Aug 10, 2018
TESTING.md Edit testing and coding documentation Apr 30, 2018
appveyor.yml Update comments in appveyor.yml Oct 12, 2017
csv_show.sh Update two csv_*.sh scripts Mar 29, 2018
csv_vars.sh Update two csv_*.sh scripts Mar 29, 2018
environment.yml Switch from pep8 to pycodestyle Apr 30, 2018
gitpr Add code-style test to Makefile Jun 5, 2018
gitsync Add code-style test to Makefile Jun 5, 2018
puf_fuzz.py Make elderly_dependent plural; add Calculator.n65() Jul 18, 2018
readthedocs.yml Add YAML file for readtheodcs Mar 1, 2016
setup.cfg Edit testing and coding documentation Apr 30, 2018
setup.py Remove taxcalc.filings[.forms] from setup.py package list May 26, 2018
simtax.py Add code-style test to Makefile Jun 5, 2018
versioneer.py resolve E226, E241, E121 Aug 10, 2015

README.md

Developing Tax-Calculator

This document tells you how to begin contributing to Tax-Calculator by reporting a bug, improving the documentation or making an enhancement to the Python source code. If you only want to use Tax-Calculator, you should begin by reading the user documentation that describes how to use Tax-Calculator on your own computer (without doing any programming) and how to use the Tax-Calculator web application called TaxBrain. If you want the most flexibility in using Tax-Calculator on your own computer, read the user documentation first and then read our Cookbook of Tested Recipes for Python Programming with Tax-Calculator.

What is Tax-Calculator?

Tax-Calculator simulates the US federal individual income and payroll tax system. In conjunction with micro data that represent the US population and a set of behavioral assumptions, Tax-Calculator can be used to conduct revenue scoring and distributional analyses of tax policies. Tax-Calculator is written in Python, an interpreted language that can execute on Windows, Mac, or Linux.

Disclaimer

Results will change as the underlying models improve. A fundamental reason for adopting open source methods in this project is so that people from all backgrounds can contribute to the models that our society uses to assess economic policy; when community-contributed improvements are incorporated, the model will produce different results.

Getting Started

If you want to report a bug, create a new issue here providing details on what you think is wrong with Tax-Calculator.

If you want to request an enhancement, create a new issue here providing details on what you think should be added to Tax-Calculator.

If you want to propose code changes, follow the directions in the Contributor Guide on how to clone the Tax-Calculator git repository. Before developing any code changes be sure to read completely the Contributor Guide and then read about our coding style and testing procedures. The Tax-Calculator release history provides a summary of past and current development work.

If you are relying on Tax-Calculator capabilities in your own project, be sure to read the definition of the Tax-Calculator Public API.

Citing Tax-Calculator

Please cite the source of your analysis as "Tax-Calculator release #.#.#, author's calculations." If you wish to link to Tax-Calculator, http://open-source-economics.github.io/Tax-Calculator/ is preferred. Additionally, we strongly recommend that you describe the input data used, and provide a link to the materials required to replicate your analysis or, at least, note that those materials are available upon request.