# A ``State``-based Transformation System for Program Compilation and Augmentation
<p align="center">
<img alt="Header image of brainstate." src="https://raw.githubusercontent.com/chaobrain/brainstate/main/docs/_static/brainstate.png" width=40%>
</p>
<p align="center">
<a href="https://pypi.org/project/brainstate/"><img alt="Supported Python Version" src="https://img.shields.io/pypi/pyversions/brainstate"></a>
<a href="https://github.com/chaobrain/brainstate/blob/main/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href='https://brainstate.readthedocs.io/?badge=latest'>
<img src='https://readthedocs.org/projects/brainstate/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://badge.fury.io/py/brainstate"><img alt="PyPI version" src="https://badge.fury.io/py/brainstate.svg"></a>
<a href="https://github.com/chaobrain/brainstate/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaobrain/brainstate/actions/workflows/CI.yml/badge.svg"></a>
<a href="https://pepy.tech/projects/brainstate"><img src="https://static.pepy.tech/badge/brainstate" alt="PyPI Downloads"></a>
<a href="https://doi.org/10.5281/zenodo.14970015"><img src="https://zenodo.org/badge/811300394.svg" alt="DOI"></a>
</p>
## Installation
You can install ``brainstate`` via pip:
```bash
pip install brainstate --upgrade
```
Alternatively, you can install `BrainX`, which bundles `brainstate` with other compatible packages for a comprehensive brain modeling ecosystem:
```bash
pip install BrainX -U
```
## Documentation
The official documentation is hosted on Read the Docs: [https://brainstate.readthedocs.io/](https://brainstate.readthedocs.io/)
## See also the brain modeling ecosystem
We are building the brain modeling ecosystem: https://brainmodeling.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://github.com/chaobrain/brainstate",
"name": "brainstate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "computational neuroscience, brain-inspired computation, brain dynamics programming",
"author": "BrainState Developers",
"author_email": "BrainState Developers <chao.brain@qq.com>",
"download_url": null,
"platform": null,
"description": "\r\n# A ``State``-based Transformation System for Program Compilation and Augmentation\r\n\r\n\r\n\r\n<p align=\"center\">\r\n \t<img alt=\"Header image of brainstate.\" src=\"https://raw.githubusercontent.com/chaobrain/brainstate/main/docs/_static/brainstate.png\" width=40%>\r\n</p> \r\n\r\n\r\n\r\n<p align=\"center\">\r\n\t<a href=\"https://pypi.org/project/brainstate/\"><img alt=\"Supported Python Version\" src=\"https://img.shields.io/pypi/pyversions/brainstate\"></a>\r\n\t<a href=\"https://github.com/chaobrain/brainstate/blob/main/LICENSE\"><img alt=\"LICENSE\" src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"></a>\r\n \t<a href='https://brainstate.readthedocs.io/?badge=latest'>\r\n <img src='https://readthedocs.org/projects/brainstate/badge/?version=latest' alt='Documentation Status' />\r\n </a>\r\n <a href=\"https://badge.fury.io/py/brainstate\"><img alt=\"PyPI version\" src=\"https://badge.fury.io/py/brainstate.svg\"></a>\r\n <a href=\"https://github.com/chaobrain/brainstate/actions/workflows/CI.yml\"><img alt=\"Continuous Integration\" src=\"https://github.com/chaobrain/brainstate/actions/workflows/CI.yml/badge.svg\"></a>\r\n <a href=\"https://pepy.tech/projects/brainstate\"><img src=\"https://static.pepy.tech/badge/brainstate\" alt=\"PyPI Downloads\"></a>\r\n <a href=\"https://doi.org/10.5281/zenodo.14970015\"><img src=\"https://zenodo.org/badge/811300394.svg\" alt=\"DOI\"></a>\r\n</p>\r\n\r\n\r\n## Installation\r\n\r\nYou can install ``brainstate`` via pip:\r\n\r\n```bash\r\npip install brainstate --upgrade\r\n```\r\n\r\nAlternatively, you can install `BrainX`, which bundles `brainstate` with other compatible packages for a comprehensive brain modeling ecosystem:\r\n\r\n```bash\r\npip install BrainX -U\r\n```\r\n\r\n## Documentation\r\n\r\nThe official documentation is hosted on Read the Docs: [https://brainstate.readthedocs.io/](https://brainstate.readthedocs.io/)\r\n\r\n\r\n\r\n## See also the brain modeling ecosystem\r\n\r\nWe are building the brain modeling ecosystem: https://brainmodeling.readthedocs.io/\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "A ``State``-based Transformation System for Program Compilation and Augmentation.",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/chaobrain/brainstate",
"homepage": "http://github.com/chaobrain/brainstate",
"repository": "http://github.com/chaobrain/brainstate"
},
"split_keywords": [
"computational neuroscience",
" brain-inspired computation",
" brain dynamics programming"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78a95e89adbbbea3ac752584479b6d6bfaf17139ad53c22ddcb3b33658143cbd",
"md5": "1fe39a88ca3d6d9b0e792e3eb99bf626",
"sha256": "a46aa99b99bb845c913767f914c0eda82c471624282bc3dec3e3e298f7d497bc"
},
"downloads": -1,
"filename": "brainstate-0.1.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1fe39a88ca3d6d9b0e792e3eb99bf626",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 407225,
"upload_time": "2025-07-08T13:04:14",
"upload_time_iso_8601": "2025-07-08T13:04:14.396629Z",
"url": "https://files.pythonhosted.org/packages/78/a9/5e89adbbbea3ac752584479b6d6bfaf17139ad53c22ddcb3b33658143cbd/brainstate-0.1.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 13:04:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaobrain",
"github_project": "brainstate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "jax",
"specs": []
},
{
"name": "jaxlib",
"specs": []
},
{
"name": "brainunit",
"specs": [
[
">=",
"0.0.13"
]
]
},
{
"name": "brainevent",
"specs": []
}
],
"lcname": "brainstate"
}
JSON
