# Ecosystem for Brain Modeling
[](https://pypi.org/project/brainx/)
[](https://github.com/chaobrain/brain-modeling-ecosystem/actions/workflows/CI.yml)
<p align="center">
<img alt="Header image of Brain Modeling Ecosystem." src="https://raw.githubusercontent.com/chaobrain/brain-modeling-ecosystem/main/docs/_static/bdp-ecosystem.png" width=50%>
</p>
## Overview
Ecosystem for Brain Modeling provides comprehensive framework for computational neuroscience and brain simulation.
It provides tools and libraries for researchers to model, simulate, train, and analyze neural systems at different scales.
**Core components** in this ecosystem includes:
- [BrainUnit](https://github.com/chaobrain/brainunit): Comprehensive physical units and unit-aware mathematical system for brain dynamics.
- [BrainCell](https://github.com/chaobrain/braincell): Intuitive, parallel, and efficient simulation for biologically detailed brain cell modeling.
- [BrainState](https://github.com/chaobrain/brainstate): State-based IR compilation for efficient simulation of brain models on CPUs, GPUs, and TPUs.
- [BrainTaichi](https://github.com/chaobrain/braintaichi): The first-generation framework for customizing event-driven operators based on Taichi Lang syntax.
- [BrainEvent](https://github.com/chaobrain/brainevent): Enabling event-driven computations in brain dynamics.
- [BrainScale](https://github.com/chaobrain/brainscale): Enabling scalable online learning for brain dynamics: $O(N)$ complexity for SNNs, and $O(N^2)$ for RNN computations.
- [BrainTools](https://github.com/chaobrain/braintools): Commonly used tools for brain dynamics programming, for example checkpointing.
## Installation
The ecosystem can be installed with the following command:
```bash
pip install BrainX -U
```
This command installs the core package and pins specific versions of the component projects known to work together, ensuring compatibility based on integration tests.
On CPU platforms, the following command can be used to install the ecosystem with all components:
```bash
pip install BrainX[cpu] -U
```
On GPU platforms, the following command can be used to install the ecosystem with all components:
```bash
pip install BrainX[cuda12] -U
```
On TPU platforms, the following command can be used to install the ecosystem with all components:
```bash
pip install BrainX[tpu] -U
```
For development, you might want to clone the repository and install it in editable mode:
```bash
git clone https://github.com/chaobrain/brain-modeling-ecosystem.git
cd brain-modeling-ecosystem
pip install -e .
```
## Documentation
For detailed documentation, tutorials, and examples, visit our [Documentation Portal](https://brainmodeling.readthedocs.io).
## Contributing
We welcome contributions from the community! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get involved.
## License
This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
## Citation
If you use the Brain Modeling Ecosystem in your research, please cite it appropriately. Refer to the [citation guide](https://brainmodeling.readthedocs.io/citation.html) on our documentation portal.
## Support
If you have questions, encounter issues, or need support, please:
* Check the [documentation](https://brainmodeling.readthedocs.io).
* Search the [existing issues](https://github.com/chaobrain/brain-modeling-ecosystem/issues).
* [Open a new issue](https://github.com/chaobrain/brain-modeling-ecosystem/issues/new/choose) if your problem is not addressed.
* Contact us via email: `chao.brain@qq.com`.
Raw data
{
"_id": null,
"home_page": "https://github.com/chaobrain/brain-modeling-ecosystem",
"name": "BrainX",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "computational neuroscience, brain-inspired computation, brain dynamics programming",
"author": "Brain Modeling Ecosystem Developers",
"author_email": "Brain Modeling Ecosystem Developers <chao.brain@qq.com>",
"download_url": null,
"platform": null,
"description": "# Ecosystem for Brain Modeling \r\n\r\n[](https://pypi.org/project/brainx/)\r\n\r\n[](https://github.com/chaobrain/brain-modeling-ecosystem/actions/workflows/CI.yml)\r\n\r\n\r\n<p align=\"center\">\r\n \t<img alt=\"Header image of Brain Modeling Ecosystem.\" src=\"https://raw.githubusercontent.com/chaobrain/brain-modeling-ecosystem/main/docs/_static/bdp-ecosystem.png\" width=50%>\r\n</p> \r\n\r\n\r\n## Overview\r\n\r\nEcosystem for Brain Modeling provides comprehensive framework for computational neuroscience and brain simulation. \r\nIt provides tools and libraries for researchers to model, simulate, train, and analyze neural systems at different scales.\r\n\r\n**Core components** in this ecosystem includes:\r\n\r\n- [BrainUnit](https://github.com/chaobrain/brainunit): Comprehensive physical units and unit-aware mathematical system for brain dynamics.\r\n\r\n- [BrainCell](https://github.com/chaobrain/braincell): Intuitive, parallel, and efficient simulation for biologically detailed brain cell modeling. \r\n\r\n- [BrainState](https://github.com/chaobrain/brainstate): State-based IR compilation for efficient simulation of brain models on CPUs, GPUs, and TPUs.\r\n\r\n- [BrainTaichi](https://github.com/chaobrain/braintaichi): The first-generation framework for customizing event-driven operators based on Taichi Lang syntax.\r\n\r\n- [BrainEvent](https://github.com/chaobrain/brainevent): Enabling event-driven computations in brain dynamics. \r\n\r\n- [BrainScale](https://github.com/chaobrain/brainscale): Enabling scalable online learning for brain dynamics: $O(N)$ complexity for SNNs, and $O(N^2)$ for RNN computations.\r\n\r\n- [BrainTools](https://github.com/chaobrain/braintools): Commonly used tools for brain dynamics programming, for example checkpointing. \r\n\r\n\r\n## Installation\r\n\r\nThe ecosystem can be installed with the following command:\r\n\r\n```bash\r\npip install BrainX -U\r\n```\r\n\r\nThis command installs the core package and pins specific versions of the component projects known to work together, ensuring compatibility based on integration tests.\r\n\r\n\r\nOn CPU platforms, the following command can be used to install the ecosystem with all components:\r\n\r\n```bash\r\npip install BrainX[cpu] -U\r\n```\r\n\r\n\r\nOn GPU platforms, the following command can be used to install the ecosystem with all components:\r\n\r\n```bash\r\npip install BrainX[cuda12] -U\r\n```\r\n\r\n\r\n\r\nOn TPU platforms, the following command can be used to install the ecosystem with all components:\r\n\r\n```bash\r\npip install BrainX[tpu] -U\r\n```\r\n\r\n\r\n\r\nFor development, you might want to clone the repository and install it in editable mode:\r\n```bash\r\ngit clone https://github.com/chaobrain/brain-modeling-ecosystem.git\r\ncd brain-modeling-ecosystem\r\npip install -e .\r\n```\r\n\r\n\r\n## Documentation\r\n\r\nFor detailed documentation, tutorials, and examples, visit our [Documentation Portal](https://brainmodeling.readthedocs.io).\r\n\r\n\r\n## Contributing\r\n\r\nWe welcome contributions from the community! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get involved.\r\n\r\n\r\n## License\r\n\r\nThis project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.\r\n\r\n\r\n## Citation\r\n\r\nIf you use the Brain Modeling Ecosystem in your research, please cite it appropriately. Refer to the [citation guide](https://brainmodeling.readthedocs.io/citation.html) on our documentation portal.\r\n\r\n\r\n## Support\r\n\r\nIf you have questions, encounter issues, or need support, please:\r\n* Check the [documentation](https://brainmodeling.readthedocs.io).\r\n* Search the [existing issues](https://github.com/chaobrain/brain-modeling-ecosystem/issues).\r\n* [Open a new issue](https://github.com/chaobrain/brain-modeling-ecosystem/issues/new/choose) if your problem is not addressed.\r\n* Contact us via email: `chao.brain@qq.com`.\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "Ecosystem for Brain Modeling.",
"version": "2025.7.14",
"project_urls": {
"Homepage": "https://github.com/chaobrain/brain-modeling-ecosystem",
"homepage": "http://github.com/chaobrain/brain-modeling-ecosystem",
"repository": "http://github.com/chaobrain/brain-modeling-ecosystem"
},
"split_keywords": [
"computational neuroscience",
" brain-inspired computation",
" brain dynamics programming"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "948664436892cf1774a48d573ef694fb5135ac2617fa4848d33f81be84a8ea51",
"md5": "10278df9cd3791c93e60c5893897a7ce",
"sha256": "b0b25798b00e6ca6bbbb23a8fa5e78b8aaea33beca8f61dd8a4c4cd08826ade9"
},
"downloads": -1,
"filename": "BrainX-2025.7.14-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "10278df9cd3791c93e60c5893897a7ce",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 8665,
"upload_time": "2025-07-13T06:04:30",
"upload_time_iso_8601": "2025-07-13T06:04:30.287854Z",
"url": "https://files.pythonhosted.org/packages/94/86/64436892cf1774a48d573ef694fb5135ac2617fa4848d33f81be84a8ea51/BrainX-2025.7.14-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-13 06:04:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaobrain",
"github_project": "brain-modeling-ecosystem",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.15"
]
]
},
{
"name": "jax",
"specs": [
[
">=",
"0.4.35"
]
]
},
{
"name": "brainunit",
"specs": [
[
"==",
"0.0.16"
]
]
},
{
"name": "brainstate",
"specs": [
[
"==",
"0.1.5"
]
]
},
{
"name": "brainevent",
"specs": [
[
">=",
"0.0.2"
]
]
},
{
"name": "braincell",
"specs": [
[
">=",
"0.0.2"
]
]
},
{
"name": "braintools",
"specs": [
[
"==",
"0.0.6"
]
]
},
{
"name": "msgpack",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "matplotlib",
"specs": []
}
],
"lcname": "brainx"
}
JSON
