# 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": "https://files.pythonhosted.org/packages/7d/3c/9dbf2070ad3682a94a23af0fc29d5da2b4e38cb4141bf1fd1e1e4ae9f62e/brainstate-0.1.9.tar.gz",
"platform": null,
"description": "\n# A ``State``-based Transformation System for Program Compilation and Augmentation\n\n\n\n<p align=\"center\">\n \t<img alt=\"Header image of brainstate.\" src=\"https://raw.githubusercontent.com/chaobrain/brainstate/main/docs/_static/brainstate.png\" width=40%>\n</p> \n\n\n\n<p align=\"center\">\n\t<a href=\"https://pypi.org/project/brainstate/\"><img alt=\"Supported Python Version\" src=\"https://img.shields.io/pypi/pyversions/brainstate\"></a>\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>\n \t<a href='https://brainstate.readthedocs.io/?badge=latest'>\n <img src='https://readthedocs.org/projects/brainstate/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"https://badge.fury.io/py/brainstate\"><img alt=\"PyPI version\" src=\"https://badge.fury.io/py/brainstate.svg\"></a>\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>\n <a href=\"https://pepy.tech/projects/brainstate\"><img src=\"https://static.pepy.tech/badge/brainstate\" alt=\"PyPI Downloads\"></a>\n <a href=\"https://doi.org/10.5281/zenodo.14970015\"><img src=\"https://zenodo.org/badge/811300394.svg\" alt=\"DOI\"></a>\n</p>\n\n\n## Installation\n\nYou can install ``brainstate`` via pip:\n\n```bash\npip install brainstate --upgrade\n```\n\nAlternatively, you can install `BrainX`, which bundles `brainstate` with other compatible packages for a comprehensive brain modeling ecosystem:\n\n```bash\npip install BrainX -U\n```\n\n## Documentation\n\nThe official documentation is hosted on Read the Docs: [https://brainstate.readthedocs.io/](https://brainstate.readthedocs.io/)\n\n\n\n## See also the brain modeling ecosystem\n\nWe are building the brain modeling ecosystem: https://brainmodeling.readthedocs.io/\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "A ``State``-based Transformation System for Program Compilation and Augmentation.",
"version": "0.1.9",
"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": null,
"digests": {
"blake2b_256": "4a09f5d7bd6c28476a47f158ff81e2b03c8e0537bc1f9e29538099768c739a3d",
"md5": "67a25d14ef6063fa3adfe594b21f468b",
"sha256": "103e092adec6cc4a432ab726cd516a37a894d7677cadb993a55361b7143e7af2"
},
"downloads": -1,
"filename": "brainstate-0.1.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "67a25d14ef6063fa3adfe594b21f468b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 403343,
"upload_time": "2025-09-13T03:06:17",
"upload_time_iso_8601": "2025-09-13T03:06:17.014749Z",
"url": "https://files.pythonhosted.org/packages/4a/09/f5d7bd6c28476a47f158ff81e2b03c8e0537bc1f9e29538099768c739a3d/brainstate-0.1.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7d3c9dbf2070ad3682a94a23af0fc29d5da2b4e38cb4141bf1fd1e1e4ae9f62e",
"md5": "e687d4f96f0dc63b9a674271ccab2c98",
"sha256": "ee0592cf405538824823c1247637ef6dbb2dec22054a9f140e2abf3193e79950"
},
"downloads": -1,
"filename": "brainstate-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "e687d4f96f0dc63b9a674271ccab2c98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 323785,
"upload_time": "2025-09-13T03:06:18",
"upload_time_iso_8601": "2025-09-13T03:06:18.938086Z",
"url": "https://files.pythonhosted.org/packages/7d/3c/9dbf2070ad3682a94a23af0fc29d5da2b4e38cb4141bf1fd1e1e4ae9f62e/brainstate-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-13 03:06:18",
"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.1.0"
]
]
},
{
"name": "brainevent",
"specs": []
}
],
"lcname": "brainstate"
}
JSON
