USA Federal Individual Income and Payroll Tax Microsimulation Model, part of the Policy Simulation Library
Branch: master
Clone or download
martinholmer Merge pull request #2229 from martinholmer/expanded-income
Simplify calculation of expanded_income
Latest commit ba39e02 Feb 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
conda.recipe Replace urllib with the requests package Feb 8, 2019
continuous_integration Undo debugging changes wrt Windows GitHub pytest errors Jan 21, 2019
docs Add a sentence to the user documentation Feb 9, 2019
read-the-docs Add new reforms tests and fix cpi_offset logic Feb 2, 2019
taxcalc Merge pull request #2229 from martinholmer/expanded-income Feb 11, 2019
.coveragerc Remove mention of taxcalc/_version.py in .coveragerc file Nov 13, 2018
.gitignore Fix typo in .gitignore Jun 6, 2018
.travis.yml Another specification of python versions in .travis.yml Dec 5, 2018
CHANGES.md Update README.md and other documentation files Jan 12, 2019
CONTRIBUTING.md Several documentation revisions Jan 15, 2019
CONTRIBUTORS.md Rename rtd/contributors.rst as CONTRIBUTORS.md and edit Jan 9, 2019
DATAPREP.md Update README.md and other documentation files Jan 12, 2019
LICENSE.md More revisions to PSLmodels card catalog information Nov 26, 2018
MANIFEST.in Remove GrowModel class and tests given plan for another repo Dec 17, 2018
Makefile Revise Makefile Jan 24, 2019
NAMING.md Rename rtd/parameter_naming.rst as NAMING.md and edit Jan 9, 2019
PSL_catalog.json Update README.md and other documentation files Jan 12, 2019
README.md Several documentation revisions Jan 15, 2019
RELEASES.md Update README.md and other documentation files Jan 12, 2019
RELEASING.md Update documentation for release 0.23.4 Dec 13, 2018
ROADMAP.md Update README.md and other documentation files Jan 12, 2019
TESTING.md Update README.md and other documentation files Jan 12, 2019
WORKFLOW.md Update README.md and other documentation files Jan 12, 2019
appveyor.yml Fully revert prior commit Jan 22, 2019
csv_show.sh Update two csv_*.sh scripts Mar 29, 2018
csv_vars.sh Update two csv_*.sh scripts Mar 29, 2018
environment.yml Replace urllib with the requests package Feb 8, 2019
gitpr Add code-style test to Makefile Jun 5, 2018
gitpr.bat Fix bug in Windows gitpr.bat batch script Oct 15, 2018
gitsync Add code-style test to Makefile Jun 5, 2018
gitsync.bat Add Window batch versions of gitsync/gitpr bash scripts Oct 2, 2018
ppp.py Write old and new parameter values to files Jan 8, 2019
readthedocs.yml Add YAML file for readtheodcs Mar 1, 2016
setup.cfg Undo all Windows-pytest debugging changes Jan 21, 2019
setup.py Update Python version info in setup.py Dec 13, 2018
tctest-nojit.sh Revise tctest-nojit.sh script Dec 3, 2018

README.md

PSL cataloged Python 3.6+ Build Status Codecov

Tax-Calculator

This document tells you how to begin using or contributing to Tax-Calculator. This is the first document to read when learning about Tax-Calculator.

If you only want to use Tax-Calculator, you should finish reading this document and then read the user guide 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 guide first and then read our Cookbook of Tested Recipes for Python Programming with Tax-Calculator.

If you also want to contribute to Tax-Calculator, you should finish reading this document, then read the user guide, and finally read the contributor guide.

What is Tax-Calculator?

Tax-Calculator simulates the USA federal individual income and payroll tax system. In conjunction with micro data that represent the USA population, Tax-Calculator can be used to estimate the aggregate revenue and distributional effects of tax reforms under static analysis assumptions. In conjunction with other modules, Tax-Calculator can be used to estimate reform effects under a range of non-static assumptions. Tax-Calculator is written in Python, an interpreted language that can execute on Windows, Mac, or Linux. It is released under an open-source license.

Disclaimer

Results will change as model data and logic 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

The first step for everyone (users and developers) is to open a free GitHub account so that you can communicate with Tax-Calculator developers. This is by far the easiest way to ask questions, make suggestions, or report bugs. Note only does this put you into direct contact with Tax-Calculator develops, it allows the community of more experienced users, all of whom are watching the Tax-Calculator GitHub repository, to answer your questions. You can create an account at the Join GitHub webpage. And then you can specify how you want to "watch" the Tax-Calculator repository by clicking on the Watch button in the upper-right corner of the Tax-Calculator main page.

The second step is to get familiar with Tax-Caclulator code by reading the code documentation.

Then after taking these two steps, you can do any of these things:

  1. If you want to ask a question, create a new issue here posing your question about Tax-Calculator as clearly as possible.

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

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

  4. If you want to propose code changes, follow the directions in the contributor guide on how to fork and clone the Tax-Calculator git repository. Before developing any code changes be sure to read completely the contributor guide. The Tax-Calculator release history and change history provide descriptions of features introduced or changed in past Tax-Calculator releases. The release history is more technical while the change history is less technical and may be sufficient for many users.

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, https://PSLmodels.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.

Additional Information