Skip to content

Commit 2dd3eae

Browse files
committed
docs: link the BrainPy to BrainX guide and migration notes
The BrainX docs now carry two pages for brainpy users: a concept page on how the packages relate, and migration notes with the module and runtime mappings. Nothing in this repository pointed at them, so brainpy readers never reached them. - README: add the concept page to the header links and both pages to the ecosystem list - docs/index.rst: add a Learn more card next to the brainpy.state APIs card - docs/api.rst: extend the brainpy.state admonition, where a reader hunting for a moved symbol will look - brainpy/state/README.md: add both pages under Documentation
1 parent a13eef5 commit 2dd3eae

4 files changed

Lines changed: 17 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ BrainPy is a flexible, efficient, and extensible framework for computational neu
2121
- **Documentation**: https://brainpy.readthedocs.io/
2222
- **Documentation (state-based)**: https://brainx.chaobrain.com/brainpy-state
2323
- **Ecosystem**: https://brainx.chaobrain.com
24+
- **BrainPy and BrainX**: https://brainx.chaobrain.com/summ/brainpy-to-brainx.html
2425

2526

2627
## Installation
@@ -64,6 +65,7 @@ We provide a Binder environment for BrainPy. You can use the following button to
6465
- **[brain modeling ecosystem](https://brainmodeling.readthedocs.io/)**: A collection of tools and libraries for brain modeling and simulation.
6566
- **[brainpy-examples](https://github.com/brainpy/examples)**: Comprehensive examples of BrainPy computation.
6667
- **[brainpy-state](https://github.com/chaobrain/brainpy.state)**: Moderize BrainPy simulation with `brainstate` syntax.
68+
- **[BrainPy to BrainX](https://brainx.chaobrain.com/summ/brainpy-to-brainx.html)**: How `brainpy` relates to the BrainX packages, and [migration notes](https://brainx.chaobrain.com/summ/brainpy-migration-notes.html) for moving a project across.
6769
- [《神经计算建模实战》 (Neural Modeling in Action)](https://github.com/c-xy17/NeuralModeling)
6870
- [第一届神经计算建模与编程培训班 (First Training Course on Neural Modeling and Programming)](https://github.com/brainpy/1st-neural-modeling-and-programming-course)
6971
- [第二届神经计算建模与编程培训班 (Second Training Course on Neural Modeling and Programming)](https://github.com/brainpy/2nd-neural-modeling-and-programming-course)

‎brainpy/state/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ For comprehensive documentation on state-based programming in BrainPy, please vi
2121

2222
- **State-based Documentation**: https://brainx.chaobrain.com/brainpy-state/
2323
- **Main BrainPy Documentation**: https://brainpy.readthedocs.io/
24+
- **BrainPy and BrainX**: https://brainx.chaobrain.com/summ/brainpy-to-brainx.html
25+
- **Migration notes**: https://brainx.chaobrain.com/summ/brainpy-migration-notes.html
2426

2527
## Source Repository
2628

‎docs/api.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ API Documentation
3232
and fully supported. See the `brainpy.state relationship page
3333
<https://brainx.chaobrain.com/brainpy-state/project/relationship.html>`_.
3434

35+
Looking for where a ``brainpy`` symbol lives in the wider ecosystem? The
36+
`BrainPy migration notes <https://brainx.chaobrain.com/summ/brainpy-migration-notes.html>`_
37+
map the classic modules onto their BrainX counterparts, and
38+
`BrainPy to BrainX <https://brainx.chaobrain.com/summ/brainpy-to-brainx.html>`_
39+
explains how the packages relate.
40+
3541
The following APIs will no longer be maintained in the future, but you can still use them normally.
3642

3743
.. toctree::

‎docs/index.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,13 @@ Learn more
120120
:class-card: sd-text-black sd-bg-light
121121
:link: https://brainx.chaobrain.com/brainpy-state/
122122

123+
.. grid-item::
124+
:columns: 6 6 6 4
125+
126+
.. card:: :material-regular:`swap_horiz;2em` BrainPy and BrainX
127+
:class-card: sd-text-black sd-bg-light
128+
:link: https://brainx.chaobrain.com/summ/brainpy-to-brainx.html
129+
123130

124131
----
125132

0 commit comments

Comments
 (0)