https://github.com/chaobrain/braintools
Modeling tools for brain simulation.
https://github.com/chaobrain/braintools
brain-dynamics-modeling brainpy
Last synced: 3 months ago
JSON representation
Modeling tools for brain simulation.
- Host: GitHub
- URL: https://github.com/chaobrain/braintools
- Owner: chaobrain
- License: apache-2.0
- Created: 2024-03-24T03:00:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-11T17:29:24.000Z (4 months ago)
- Last Synced: 2026-03-11T21:59:58.762Z (4 months ago)
- Topics: brain-dynamics-modeling, brainpy
- Language: Python
- Homepage: https://braintools.readthedocs.io/
- Size: 41 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Modeling tools for brain simulation
`braintools` is a lightweight, JAX-friendly toolbox with practical utilities for brain modeling.
## Highlights
- **Composable connectivity**: declarative builders for point, multi-compartment, and population networks with spatial kernels, degree constraints, and unit-aware metadata
- **Visualization suite**: publication plots, interactive dashboards, 3D viewers, and animation helpers in `braintools.visualize`
- **Metrics and solvers**: losses, evaluation metrics, and PyTree-aware ODE/SDE/DDE integrators ready for `jit`/`vmap`
- **Signal and optimization helpers**: reusable generators and lightweight optimizers to prototype models quickly
`braintools` integrates smoothly with the broader ecosystem (e.g., `brainstate`, `brainunit`) while keeping a simple, functional style.
## Installation
```bash
pip install -U braintools
```
Optional extras are published for hardware-specific builds:
```bash
pip install -U braintools[cpu]
# CUDA 12.x wheels
pip install -U braintools[cuda12]
# TPU runtime
pip install -U braintools[tpu]
```
Alternatively, install the curated BrainX bundle that ships with `braintools` and related projects:
```bash
pip install -U BrainX
```
## Documentation
The full documentation is available at https://braintools.readthedocs.io
## Ecosystem
`braintools` is one part of our brain simulation ecosystem: https://brainmodeling.readthedocs.io/
## Contributing
Contributions and issue reports are welcome! See `CONTRIBUTING.md` for guidelines.
## License
Apache 2.0. See `LICENSE` for details.
## Citation
If you use `braintools` in your work, please cite the Zenodo DOI: [10.5281/zenodo.17110064](https://doi.org/10.5281/zenodo.17110064)