Skip to content
Tax-Brain is an integrator model for PSL tax models
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
compconfig set use_full_sample to true May 14, 2019
conda.recipe Upgrade to taxcalc 2.0.0 May 3, 2019
taxbrain remove tbi reference May 13, 2019
.gitignore Update gitignore May 6, 2019
CONTRIBUTING.md Allow PUF use in the TBI Mar 27, 2019
DOC.md add model documentation Mar 17, 2019
LICENSE.md
MANIFEST.in modify setup.py May 6, 2019
PSL_catalog.json PSL_catalog.json typo Apr 16, 2019
README.md Update COMP links in the README May 6, 2019
RELEASES.md update releases Apr 1, 2019
ROADMAP.md Add more sophisticated user input processing Mar 6, 2019
USAGE.md remove unneeded keys in behavioral json Mar 20, 2019
environment.yml Upgrade to taxcalc 2.0.0 May 3, 2019
example.ipynb remove unneeded keys in behavioral json Mar 20, 2019
example.py remove unneeded keys in behavioral json Mar 20, 2019
setup.py Update compconfig May 6, 2019

README.md

Tax-Brain

Tax-Brain is a Python package that wraps multiple economic models in one easy to use interface.

Overview

Tax-Brain makes it easy for users to simulate the US tax system by providing a single interface for multiple tax models. Currently, Tax-Brain interfaces with Tax-Calculator and Behavior-Response. Additional models will be added in the near future to expand Tax-Brain's capabilities to include modeling business taxation and running dynamic general equilibrium simulations.

To learn more about how Tax-Brain works, see this document.

Disclaimer

Tax-brain and it's underlying models are constantly being improved upon. For that reason, the results output by Tax-Brain may differ over time. It is strongly suggested that the user make note of which version of Tax-Brain, they are using when reporting their results.

Installing Tax-Brain

You can install the latest official release from Conda using this command: conda install -c pslmodels taxbrain.

Similarly, you can update to the latest release of Tax-Brain using conda update -c pslmodels taxbrain.

Tax-Brain is currently not available on PyPI.

Using Tax-Brain

View the sample code in example.py to see how to run Tax-Brain. Or, see this document for a more detailed walk through.

Citing Tax-Brain

Please cite the source of your analysis as "Tax-Brain release #.#.#, author's calculations." If you would like to link to Tax-Brain, please use https://github.com/PSLmodels/Tax-Brain. It is also strongly suggested that you describe your input data and note the versions of the underlying models.

Tax-Brain Interface

In addition to its Python API, Tax-Brain also powers a web application on COMP. That application can be found here. The code behind the GUI can be found in this repository in the compconfig directory.

Additional Information

Looking for code powering the TaxBrain GUI at apps.ospc.org/taxbrain? See github.com/ospc-org/ospc.org.

You can’t perform that action at this time.