Python library for advanced tax policy analysis
Project description
# 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](https://github.com/PSLmodels/Tax-Calculator) and [Behavioral-Responses](https://github.com/PSLmodels/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](http://taxbrain.pslmodels.org).
## 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 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]([example.py](http://taxbrain.pslmodels.org/content/examples/example.html)) to see how to run Tax-Brain. Or, see [the user guide](http://taxbrain.pslmodels.org/content/usage.html) 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 [Compute Studio](https://compute.studio/). That application can be found [here](https://compute.studio/PSLmodels/Tax-Brain/). The code behind the GUI can be found in this repository in the [cs-config](https://github.com/PSLmodels/Tax-Brain/tree/master/cs-config) directory.
## Additional Information
[Project Road Map](https://github.com/PSLmodels/Tax-Brain/blob/master/ROADMAP.md)
[Contributing](http://taxbrain.pslmodels.org/content/contributing/contributor_guide.html)
[Contributors](https://github.com/PSLmodels/Tax-Brain/graphs/contributors)
[Release History](https://github.com/PSLmodels/Tax-Brain/blob/master/RELEASES.md)
## Releasing New Versions of Tax-Brain
To release new versions of Tax-Brain, use the [Package-Builder](https://github.com/PSLmodels/Package-Builder) tool. Before using the tool, be sure to add the conda-forge channel to your conda config by using conda config –add channels conda-forge.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.