Skip to content

PSLmodels/Tax-Brain

Repository files navigation

Org PSL cataloged OS License: CCO-1.0 Jupyter Book Badge
Package Python 3.10 Python 3.11 Python 3.12 PyPI Latest Release PyPI Downloads Anaconda
Testing example event parameter example event parameter Codecov

Tax-Brain

Tax-Brain is a Python package that wraps two models, Tax-Calculator and Behavioral Responses, in one easy to use interface for producing revenue estimates and distributional analysis of tax policy changes.

We are seeking contributors and maintainers. If you are interested in joining the project as a contributor or maintainer, open a new issue and ping @jdebacker -- or just jump right in.

Complete documentation is available at taxbrain.pslmodels.org.

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 Behavioral-Responses. 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 the Tax-Brain documentation.

Disclaimer

Tax-brain and its 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 PyPI using this command: pip taxbrain.

Similarly, you can update to the latest release of Tax-Brain using pip install -U taxbrain.

Tax-Brain is no longer maintained on Conda.

Using Tax-Brain

View the sample code in example.py to see how to run Tax-Brain. Or, see the user guide 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 has also been used to power web applications on Compute Studio and other platforms. An application used to be available at here. The code behind the GUI web application can be found in this repository in the cs-config directory.

Additional Information