USA Federal Individual Income and Payroll Tax Microsimulation Model, part of the Policy Simulation Library
martinholmer Merge pull request #2167 from martinholmer/badges
Change location and color of PSL-cataloged badge
Latest commit c806072 Dec 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
conda.recipe Merge branch 'master' into python-versions Dec 5, 2018
continuous_integration Remove timing calls in taxcalc/tbi/tbi.py Oct 22, 2018
docs Update GitHub organization name Dec 5, 2018
read-the-docs Update GitHub organization name Dec 5, 2018
taxcalc Update taxcalc/validation/taxsim/README.md text Dec 8, 2018
.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 GitHub organization name Dec 5, 2018
DATAPREP.md Update GitHub organization name Dec 5, 2018
LICENSE.md More revisions to PSLmodels card catalog information Nov 26, 2018
MANIFEST.in Rename current_law_policy.json as policy_current_law.json Oct 2, 2018
Makefile Add tctest-jit target to Makefile Dec 3, 2018
PSL_catalog.json Update GitHub organization name Dec 5, 2018
README.md Change color of PSL-cataloged badge Dec 10, 2018
RELEASES.md Update GitHub organization name Dec 5, 2018
RELEASING.md Make What's New section point to CHANGES.md Nov 26, 2018
ROADMAP.md Update GitHub organization name Dec 5, 2018
TESTING.md Update GitHub organization name Dec 5, 2018
WORKFLOW.md Update GitHub organization name Dec 5, 2018
appveyor.yml Add docker service to .travis.yml file Dec 5, 2018
csv_show.sh Update two csv_*.sh scripts Mar 29, 2018
csv_vars.sh Update two csv_*.sh scripts Mar 29, 2018
environment.yml Remove python version in environment.yml and conda.recipe/meta.yaml Dec 5, 2018
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
readthedocs.yml Add YAML file for readtheodcs Mar 1, 2016
setup.cfg Edit testing and coding documentation Apr 30, 2018
setup.py Update GitHub organization name Dec 5, 2018
tctest-nojit.sh Revise tctest-nojit.sh script Dec 3, 2018

README.md

PSL cataloged Python 3.6 Build Status Codecov

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 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.

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

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 fork and clone the Tax-Calculator git repository. Before developing any code changes be sure to read completely the Contributor Guide and then read about the pull-request workflow. The Tax-Calculator release history provides a high-level summary of past pull requests and access to a complete list of merged, closed, and pending pull requests.

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, 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.