# 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`.
Raw data
{
"_id": null,
"home_page": "https://github.com/PSLmodels/Tax-Brain",
"name": "taxbrain",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Anderson Frailey",
"author_email": "andersonfrailey@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8b/99/6e239a740af909ced7aba3ac61b0bf4c76a54e61d49f8ac6e35692ce626d/taxbrain-2.7.0.tar.gz",
"platform": null,
"description": "# Tax-Brain\n\nTax-Brain is a Python package that wraps multiple economic models in one easy\nto use interface.\n\n## Overview\n\nTax-Brain makes it easy for users to simulate the US tax system by providing a\nsingle interface for multiple tax models. Currently, Tax-Brain interfaces with\n[Tax-Calculator](https://github.com/PSLmodels/Tax-Calculator) and\n[Behavioral-Responses](https://github.com/PSLmodels/Behavioral-Responses).\nAdditional models will be added in the near future to expand Tax-Brain's\ncapabilities to include modeling business taxation and running dynamic\ngeneral equilibrium simulations.\n\nTo learn more about how Tax-Brain works, see [the Tax-Brain documentation](http://taxbrain.pslmodels.org).\n\n## Disclaimer\n\nTax-brain and its underlying models are constantly being improved upon. For\nthat reason, the results output by Tax-Brain may differ over time. It is\nstrongly suggested that the user make note of which version of Tax-Brain,\nthey are using when reporting their results.\n\n## Installing Tax-Brain\n\nYou can install the latest official release from Conda using this command:\n`conda install -c pslmodels taxbrain`.\n\nSimilarly, you can update to the latest release of Tax-Brain using\n`conda update -c pslmodels taxbrain`.\n\nTax-Brain is currently not available on PyPI.\n\n## Using Tax-Brain\n\nView the sample code in [example.py]([example.py](http://taxbrain.pslmodels.org/content/examples/example.html)) to see how to run Tax-Brain.\nOr, see [the user guide](http://taxbrain.pslmodels.org/content/usage.html)\nfor a more detailed walk through.\n\n## Citing Tax-Brain\n\nPlease cite the source of your analysis as \"Tax-Brain release #.#.#, author's\ncalculations.\" If you would like to link to Tax-Brain, please use\n`https://github.com/PSLmodels/Tax-Brain`. It is also strongly suggested that\nyou describe your input data and note the versions of the underlying models.\n\n## Tax-Brain Interface\n\nIn addition to its Python API, Tax-Brain also powers a web application on\n[Compute Studio](https://compute.studio/). That application can be found\n[here](https://compute.studio/PSLmodels/Tax-Brain/). The code behind the\nGUI can be found in this repository in the [cs-config](https://github.com/PSLmodels/Tax-Brain/tree/master/cs-config)\ndirectory.\n\n## Additional Information\n\n* [Project Road Map](https://github.com/PSLmodels/Tax-Brain/blob/master/ROADMAP.md)\n* [Contributing](http://taxbrain.pslmodels.org/content/contributing/contributor_guide.html)\n* [Contributors](https://github.com/PSLmodels/Tax-Brain/graphs/contributors)\n* [Release History](https://github.com/PSLmodels/Tax-Brain/blob/master/RELEASES.md)\n\n## Releasing New Versions of Tax-Brain\n\nTo release new versions of Tax-Brain, use the [Package-Builder](https://github.com/PSLmodels/Package-Builder)\ntool. Before using the tool, be sure to add the conda-forge channel to your\nconda config by using `conda config --add channels conda-forge`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library for advanced tax policy analysis",
"version": "2.7.0",
"project_urls": {
"Homepage": "https://github.com/PSLmodels/Tax-Brain"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81d6780e22654c62c441fac6688c00d00d338e0b24040410520778f7a9d3f623",
"md5": "2ea969b6bf42f4a3a34605dd6dd2a9ec",
"sha256": "6b75b41408324b2ef947285ae93fa295efe841e127022fd9e70cbec537a0297c"
},
"downloads": -1,
"filename": "taxbrain-2.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ea969b6bf42f4a3a34605dd6dd2a9ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 46341,
"upload_time": "2024-05-17T00:29:26",
"upload_time_iso_8601": "2024-05-17T00:29:26.087004Z",
"url": "https://files.pythonhosted.org/packages/81/d6/780e22654c62c441fac6688c00d00d338e0b24040410520778f7a9d3f623/taxbrain-2.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b996e239a740af909ced7aba3ac61b0bf4c76a54e61d49f8ac6e35692ce626d",
"md5": "9a284cc71ce68a3bae8ec184486c09f1",
"sha256": "40366bbe80294aeea310ce33f9f752105f9c65b067f0ba31898ec680c33b88cc"
},
"downloads": -1,
"filename": "taxbrain-2.7.0.tar.gz",
"has_sig": false,
"md5_digest": "9a284cc71ce68a3bae8ec184486c09f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 46981,
"upload_time": "2024-05-17T00:29:28",
"upload_time_iso_8601": "2024-05-17T00:29:28.013431Z",
"url": "https://files.pythonhosted.org/packages/8b/99/6e239a740af909ced7aba3ac61b0bf4c76a54e61d49f8ac6e35692ce626d/taxbrain-2.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-17 00:29:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PSLmodels",
"github_project": "Tax-Brain",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "taxbrain"
}