Skip to content
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

Jump to bottom

[doc] update the API of brainpy.dyn module & add synaptic plasticity module #492

Merged
merged 2 commits into from
Sep 11, 2023
Merged

[doc] update the API of brainpy.dyn module & add synaptic plasticity module #492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d569c5f
[doc] update the API doc of `brainpy.dyn` module
chaoming0625 Sep 11, 2023
1d28b37
[plasticity] add synaptic plasticity module
chaoming0625 Sep 11, 2023
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
1 change: 1 addition & 0 deletions brainpy/dyn/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from .neurons import *
from .synapses import *
from .projections import *
from .plasticity import *
from .others import *
from .outs import *
from .rates import *
Expand Down
4 changes: 0 additions & 4 deletions brainpy/dyn/projections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@


from brainpy._src.dyn.projections.aligns import (
VanillaProj,
ProjAlignPostMg1,
Expand All @@ -20,7 +19,4 @@
PoissonInput as PoissonInput,
)

from brainpy._src.dyn.projections.plasticity import (
STDP_Song2000 as STDP_Song2000,
)

14 changes: 14 additions & 0 deletions docs/apis/brainpy.dyn.base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Base Classes
============

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

NeuDyn
SynDyn
IonChaDyn
101 changes: 101 additions & 0 deletions docs/apis/brainpy.dyn.channels.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
Ion Channel Dynamics
====================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn

.. contents::
:local:
:depth: 1


Base Classes
------------

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

IonChannel



Calcium Channels
-----------------

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

CalciumChannel
ICaN_IS2008
ICaT_HM1992
ICaT_HP1992
ICaHT_HM1992
ICaHT_Re1993
ICaL_IS2008


Potassium Channels
------------------

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

PotassiumChannel
IKDR_Ba2002v2
IK_TM1991v2
IK_HH1952v2
IKA1_HM1992v2
IKA2_HM1992v2
IKK2A_HM1992v2
IKK2B_HM1992v2
IKNI_Ya1989v2
IK_Leak
IKDR_Ba2002
IK_TM1991
IK_HH1952
IKA1_HM1992
IKA2_HM1992
IKK2A_HM1992
IKK2B_HM1992
IKNI_Ya1989
IKL



Sodium Channels
------------------

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

SodiumChannel
INa_Ba2002
INa_TM1991
INa_HH1952
INa_Ba2002v2
INa_TM1991v2
INa_HH1952v2


Other Channels
------------------

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

Ih_HM1992
Ih_De1996
IAHP_De1994v2
IAHP_De1994
LeakyChannel
IL
23 changes: 23 additions & 0 deletions docs/apis/brainpy.dyn.ions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Ion Dynamics
======================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn


.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

mix_ions
Ion
MixIons
Calcium
CalciumFixed
CalciumDetailed
CalciumFirstOrder
Sodium
SodiumFixed
Potassium
PotassiumFixed
72 changes: 72 additions & 0 deletions docs/apis/brainpy.dyn.neurons.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Neuron Dynamics
===============

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn


Reduced Neuron Models
---------------------

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

Lif
LifLTC
LifRefLTC
LifRef
ExpIF
ExpIFLTC
ExpIFRefLTC
ExpIFRef
AdExIF
AdExIFLTC
AdExIFRefLTC
AdExIFRef
QuaIF
QuaIFLTC
QuaIFRefLTC
QuaIFRef
AdQuaIF
AdQuaIFLTC
AdQuaIFRefLTC
AdQuaIFRef
Gif
GifLTC
GifRefLTC
GifRef
Izhikevich
IzhikevichLTC
IzhikevichRefLTC
IzhikevichRef
HHTypedNeuron
CondNeuGroupLTC
CondNeuGroup
HH
HHLTC
MorrisLecar
MorrisLecarLTC
WangBuzsakiHH
WangBuzsakiHHLTC


Hodgkin–Huxley Neuron Models
----------------------------

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

HHTypedNeuron
CondNeuGroupLTC
CondNeuGroup
HH
HHLTC
MorrisLecar
MorrisLecarLTC
WangBuzsakiHH
WangBuzsakiHHLTC

21 changes: 21 additions & 0 deletions docs/apis/brainpy.dyn.others.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Common Dynamical Models
======================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

Leaky
Integrator
InputGroup
OutputGroup
SpikeTimeGroup
PoissonGroup
OUProcess



16 changes: 16 additions & 0 deletions docs/apis/brainpy.dyn.outs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Synaptic Outputs
================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn


.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

SynOut
COBA
CUBA
MgBlock
12 changes: 12 additions & 0 deletions docs/apis/brainpy.dyn.plasticity.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Synaptic Plasticity
===================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn

.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

STDP_Song2000
24 changes: 24 additions & 0 deletions docs/apis/brainpy.dyn.projections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Synaptic Projections
======================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn



.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

VanillaProj
ProjAlignPostMg1
ProjAlignPostMg2
ProjAlignPost1
ProjAlignPost2
ProjAlignPreMg1
ProjAlignPreMg2
ProjAlignPre1
ProjAlignPre2
SynConn
PoissonInput
20 changes: 20 additions & 0 deletions docs/apis/brainpy.dyn.rates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Population Rate Models
======================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn


.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

FHN
FeedbackFHN
QIF
StuartLandauOscillator
WilsonCowanModel
ThresholdLinearModel


25 changes: 25 additions & 0 deletions docs/apis/brainpy.dyn.synapses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Synaptic Dynamics
======================

.. currentmodule:: brainpy.dyn
.. automodule:: brainpy.dyn


.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate.rst

Delta
Expon
Alpha
DualExpon
DualExponV2
NMDA
STD
STP
AMPA
GABAa
BioNMDA
DiffusiveCoupling
AdditiveCoupling
Loading
Loading