# A ``State``-based Transformation System for Brain Modeling
<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 ecosystem
``brainstate`` is one part of our brain simulation ecosystem: https://brainmodeling.readthedocs.io/
Raw data
{
"_id": null,
"home_page": null,
"name": "brainstate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "computational neuroscience, brain-inspired computing, brain simulation, brain modeling, spiking neural networks",
"author": null,
"author_email": "BrainState Developers <chao.brain@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/b8/12/b4a7d2976c3c34c6b79a1a81ee6db714b5df464804830d5650f27ff5824b/brainstate-0.2.6.tar.gz",
"platform": null,
"description": "\r\n# A ``State``-based Transformation System for Brain Modeling\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 ecosystem\r\n\r\n``brainstate`` is one part of our brain simulation ecosystem: https://brainmodeling.readthedocs.io/\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A State-based Transformation System for Brain Modeling.",
"version": "0.2.6",
"project_urls": {
"Bug Tracker": "https://github.com/chaobrain/brainstate/issues",
"Documentation": "https://brainstate.readthedocs.io/",
"Source Code": "https://github.com/chaobrain/brainstate",
"homepage": "https://github.com/chaobrain/brainstate",
"repository": "https://github.com/chaobrain/brainstate"
},
"split_keywords": [
"computational neuroscience",
" brain-inspired computing",
" brain simulation",
" brain modeling",
" spiking neural networks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b422b87badca14fbd3b62ac96d46eb6ae737e40f45bf95dcf66354f4894045d",
"md5": "bc524445b6933c778d4c2e9950b23ef9",
"sha256": "d5d64ba0a14320ca9706b2f7005e7740d78457c29f783560537c46fc74c5383c"
},
"downloads": -1,
"filename": "brainstate-0.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc524445b6933c778d4c2e9950b23ef9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 557348,
"upload_time": "2025-11-01T13:35:14",
"upload_time_iso_8601": "2025-11-01T13:35:14.989775Z",
"url": "https://files.pythonhosted.org/packages/4b/42/2b87badca14fbd3b62ac96d46eb6ae737e40f45bf95dcf66354f4894045d/brainstate-0.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b812b4a7d2976c3c34c6b79a1a81ee6db714b5df464804830d5650f27ff5824b",
"md5": "01197709456ebc5de24160b471c42521",
"sha256": "3af8da731fffc83920329324d9d10db139185313f45ca09ee7bd618fb60f6e54"
},
"downloads": -1,
"filename": "brainstate-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "01197709456ebc5de24160b471c42521",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 480311,
"upload_time": "2025-11-01T13:35:18",
"upload_time_iso_8601": "2025-11-01T13:35:18.182437Z",
"url": "https://files.pythonhosted.org/packages/b8/12/b4a7d2976c3c34c6b79a1a81ee6db714b5df464804830d5650f27ff5824b/brainstate-0.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-01 13:35: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
