Ecosystem for Brain Modeling

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: Comprehensive physical units and unit-aware mathematical system for brain dynamics.

• BrainCell: Intuitive, parallel, and efficient simulation for biologically detailed brain cell modeling.

• BrainState: State-based IR compilation for efficient simulation of brain models on CPUs, GPUs, and TPUs.

• BrainTaichi: The first-generation framework for customizing event-driven operators based on Taichi Lang syntax.

• BrainEvent: Enabling event-driven computations in brain dynamics.

• BrainScale: Enabling scalable 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.

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

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/brain-modeling-ecosystem.git
cd brain-modeling-ecosystem
pip install -e .

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 Brain Modeling 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.