Skip to content

Commit a1dfb3d

Browse files
committed
[update] Enhance documentation with Ecosystem installation instructions and update citation details
1 parent b21cb26 commit a1dfb3d

3 files changed

Lines changed: 40 additions & 8 deletions

File tree

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ BrainPy is a flexible, efficient, and extensible framework for computational neu
2222
- **Ecosystem**: https://brainmodeling.readthedocs.io/
2323

2424

25-
BrainPy now is rewritten based on [brainstate](https://github.com/chaobrain/brainstate), please learn [brainstate documentation](https://brainstate.readthedocs.io/) for the latest updates.
25+
BrainPy is rewritten based on [brainstate](https://github.com/chaobrain/brainstate) since August 2025, please learn [brainstate documentation](https://brainstate.readthedocs.io/) for the latest updates.
2626

2727

2828
## Installation
@@ -57,17 +57,38 @@ We provide a Binder environment for BrainPy. You can use the following button to
5757

5858
- **[BrainPy](https://github.com/brainpy/BrainPy)**: The solution for the general-purpose brain dynamics programming.
5959
- **[brainpy-examples](https://github.com/brainpy/examples)**: Comprehensive examples of BrainPy computation.
60-
- **[brainpy-datasets](https://github.com/brainpy/datasets)**: Neuromorphic and Cognitive Datasets for Brain Dynamics Modeling.
60+
- **[brain modeling ecosystem](https://brainmodeling.readthedocs.io/)**: A collection of tools and libraries for brain modeling and simulation.
6161
- [《神经计算建模实战》 (Neural Modeling in Action)](https://github.com/c-xy17/NeuralModeling)
6262
- [第一届神经计算建模与编程培训班 (First Training Course on Neural Modeling and Programming)](https://github.com/brainpy/1st-neural-modeling-and-programming-course)
6363
- [第二届神经计算建模与编程培训班 (Second Training Course on Neural Modeling and Programming)](https://github.com/brainpy/2nd-neural-modeling-and-programming-course)
64-
- **[brain modeling ecosystem](https://brainmodeling.readthedocs.io/)**: A collection of tools and libraries for brain modeling and simulation.
6564

6665

6766
## Citing
6867

6968
BrainPy is developed by a team in Neural Information Processing Lab at Peking University, China.
7069
Our team is committed to the long-term maintenance and development of the project.
7170

72-
If you are using ``brainpy``, please consider citing [the corresponding papers](https://brainpy.readthedocs.io/en/latest/tutorial_FAQs/citing_and_publication.html).
71+
If you are using ``brainpy``, please consider citing the corresponding paper:
72+
73+
```bibtex
74+
@article {10.7554/eLife.86365,
75+
article_type = {journal},
76+
title = {BrainPy, a flexible, integrative, efficient, and extensible framework for general-purpose brain dynamics programming},
77+
author = {Wang, Chaoming and Zhang, Tianqiu and Chen, Xiaoyu and He, Sichao and Li, Shangyang and Wu, Si},
78+
editor = {Stimberg, Marcel},
79+
volume = 12,
80+
year = 2023,
81+
month = {dec},
82+
pub_date = {2023-12-22},
83+
pages = {e86365},
84+
citation = {eLife 2023;12:e86365},
85+
doi = {10.7554/eLife.86365},
86+
url = {https://doi.org/10.7554/eLife.86365},
87+
abstract = {Elucidating the intricate neural mechanisms underlying brain functions requires integrative brain dynamics modeling. To facilitate this process, it is crucial to develop a general-purpose programming framework that allows users to freely define neural models across multiple scales, efficiently simulate, train, and analyze model dynamics, and conveniently incorporate new modeling approaches. In response to this need, we present BrainPy. BrainPy leverages the advanced just-in-time (JIT) compilation capabilities of JAX and XLA to provide a powerful infrastructure tailored for brain dynamics programming. It offers an integrated platform for building, simulating, training, and analyzing brain dynamics models. Models defined in BrainPy can be JIT compiled into binary instructions for various devices, including Central Processing Unit (CPU), Graphics Processing Unit (GPU), and Tensor Processing Unit (TPU), which ensures high running performance comparable to native C or CUDA. Additionally, BrainPy features an extensible architecture that allows for easy expansion of new infrastructure, utilities, and machine-learning approaches. This flexibility enables researchers to incorporate cutting-edge techniques and adapt the framework to their specific needs},
88+
journal = {eLife},
89+
issn = {2050-084X},
90+
publisher = {eLife Sciences Publications, Ltd},
91+
}
92+
```
93+
7394

docs/api.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ API Documentation
44
.. toctree::
55
:maxdepth: 1
66

7-
apis/auto/brainpy-changelog.md
8-
apis/auto/brainpylib-changelog.md
7+
98
apis/brainpy.rst
109
apis/math.rst
1110
apis/dnn.rst

docs/index.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ Installation
3131
3232
pip install -U brainpy[tpu]
3333
34+
.. tab-item:: Ecosystem
35+
36+
.. code-block:: bash
37+
38+
pip install -U BrainX[cpu]
39+
# or
40+
pip install -U BrainX[cuda12]
41+
# or
42+
pip install -U BrainX[tpu]
43+
44+
3445
3546
----
3647

@@ -93,7 +104,7 @@ Learn more
93104

94105
.. card:: :material-regular:`settings;2em` Examples
95106
:class-card: sd-text-black sd-bg-light
96-
:link: https://brainpy-examples.readthedocs.io/en/latest/index.html
107+
:link: https://brainpy-examples.readthedocs.io/
97108

98109
.. grid-item::
99110
:columns: 6 6 6 4
@@ -140,4 +151,5 @@ Learn more
140151
advanced_tutorials.rst
141152
FAQ.rst
142153
api.rst
143-
154+
apis/auto/brainpy-changelog.md
155+
apis/auto/brainpylib-changelog.md

0 commit comments

Comments
 (0)