Brain Simulation Ecosystem (BrainX)
Overview
The BrainX ecosystem provides a comprehensive framework for brain simulation and modeling. It provides tools and libraries for researchers to model, simulate, train, and analyze neural systems at different scales.
Core components in this ecosystem includes:
-
BrainPy: Modeling of point neuron-based spiking neural networks (SNNs), comes from Prof. Si Wu's lab at Peking University.
-
BrainUnit: Comprehensive physical units and unit-aware mathematical system for brain dynamics.
-
BrainCell: Intuitive, parallel, and efficient simulation for biologically detailed brain cell modeling. Collaborated with Prof. Songting Li's lab at Shanghai Jiao Tong University.
-
BrainMass: Whole-brain modeling with differentiable neural mass models.
-
BrainState: State-based IR compilation for efficient simulation of brain models on CPUs, GPUs, and TPUs.
-
BrainEvent: Enabling event-driven computations in brain dynamics.
-
BrainTrace: Eligibility trace-based online learning for brain dynamics: $O(N)$ complexity for SNNs and $O(N^2)$ for RNN computations.
-
BrainTools: Commonly used tools for brain dynamics programming, for example checkpointing.
-
PINNx: Physics-informed neural networks for scientific machine learning in JAX.
-
More components may be added in the future.
Installation
The ecosystem can be installed with the following command:
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:
pip install BrainX[cpu] -U
On GPU platforms, the following command can be used to install the ecosystem with all components:
pip install BrainX[cuda12] -U
pip install BrainX[cuda13] -U
On TPU platforms, the following command can be used to install the ecosystem with all components:
pip install BrainX[tpu] -U
For development, you might want to clone the repository and install it in editable mode:
git clone https://github.com/chaobrain/brainx.git
cd brainx
pip install -e .
BrainX Skill
Install the BrainX skill for your coding agent with:
npx brainx-skill install
Documentation
For detailed documentation, tutorials, and examples, visit our Documentation Portal.
Contributing
We welcome contributions from the community! Please see our Contributing Guidelines for more information on how to get involved.
License
This project is licensed under the Apache License, Version 2.0. See the LICENSE file for details.
Citation
If you use the BrainX Ecosystem in your research, please cite it appropriately. Refer to the citation guide on our documentation portal.
Support
If you have questions, encounter issues, or need support, please:
- Check the documentation.
- Search the existing issues.
- Open a new issue if your problem is not addressed.
- Contact us via email:
chao.brain@qq.com.
1 maintainer
Metadata
1 maintainer
Release files for BrainX 2026.8.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| brainx-2026.8.18.tar.gz | 13.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| brainx-2026.8.18-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.9 kB
Release files / brainx-2026.8.18.tar.gz
| Download URL | brainx-2026.8.18.tar.gz |
|---|---|
| Size | 13.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db774ecf7ad600a3203e8fc1bb6eb4dcc8ce91d2bd491996beda6a9df3ded307
|
|
BLAKE2b-256 checksum How to use checksums |
dafb9857fde148257c47751cd651b90f177c092d0d38df3d55d7a682fa6624e7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / brainx-2026.8.18-py3-none-any.whl
| Download URL | brainx-2026.8.18-py3-none-any.whl |
|---|---|
| Size | 13.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c3b593af9b19196fef1d6f67003779002e2f99d61eea92edd2805cf0fdec4003
|
|
BLAKE2b-256 checksum How to use checksums |
dd645cf7e853c5ba547e8b93ad1c58bdbac053131b718ab77cf8e6e5dad27635
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
