Skip to content

Update doc #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 25, 2020
Merged

Update doc #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 conda-recipe/meta.yaml → docs/conda-recipe/meta.yaml
View file
Open in desktop
File renamed without changes.
18 changes: 4 additions & 14 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
NumpyBrain documentation
BrainPy documentation
========================

``NumpyBrain`` is a microkernel framework for SNN (spiking neural network) simulation
``BrainPy`` is a microkernel framework for neuronal dynamics simulation
purely based on **native** python. It only relies on `NumPy <https://numpy.org/>`_.
However, if you want to get faster performance,you can additionally
install `Numba <http://numba.pydata.org/>`_. With `Numba`, the speed of C or FORTRAN can
Expand All @@ -10,9 +10,9 @@ be obtained in the simulation.

.. note::

NumpyBrain is a project under development.
BrainPy is a project under development.
More features are coming soon. Contributions are welcome.
https://github.com/chaoming0625/NumpyBrain
https://github.com/PKU-NIP-Lab/BrainPy


.. toctree::
Expand All @@ -32,16 +32,6 @@ be obtained in the simulation.
guides/synapses
guides/numerical_integrators

.. toctree::
:maxdepth: 2
:caption: API references

apis/core
apis/neurons
apis/synapses
apis/utils
apis/changelog


Indices and tables
==================
Expand Down