Skip to content

Further improve iaf_psc_alpha documentation #3034

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
jessica-mitchell merged 2 commits into from
Dec 21, 2023
Merged

Further improve iaf_psc_alpha documentation #3034

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e80c1f
Further improve iaf_psc_alpha documentation
heplesser Dec 6, 2023
9c30853
Fix table formatting.
heplesser Dec 15, 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
46 changes: 31 additions & 15 deletions models/iaf_psc_alpha.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ Description
* no adaptation mechanisms,
* :math:`\alpha`-shaped synaptic input currents.

Membrane potential evolution, spike emission, and refractoriness
................................................................

The membrane potential evolves according to

.. math::
Expand All @@ -76,6 +79,9 @@ Subsequently,

that is, the membrane potential is clamped to :math:`V_{\text{reset}}` during the refractory period.

Synaptic input
..............

The synaptic input current has an excitatory and an inhibitory component

.. math::
Expand Down Expand Up @@ -136,21 +142,31 @@ Parameters

The following parameters can be set in the status dictionary.

=============== ======== =============================== ========================================================================
**Parameter** **Unit** **Math equivalent** **Description**
=============== ======== =============================== ========================================================================
``V_m`` mV :math:`V_{\text{m}}` Membrane potential
``E_L`` mV :math:`E_\text{L}` Resting membrane potential
``C_m`` pF :math:`C_{\text{m}}` Capacity of the membrane
``tau_m`` ms :math:`\tau_{\text{m}}` Membrane time constant
``t_ref`` ms :math:`t_{\text{ref}}` Duration of refractory period
``V_th`` mV :math:`V_{\text{th}}` Spike threshold
``V_reset`` mV :math:`V_{\text{reset}}` Reset potential of the membrane
``tau_syn_ex`` ms :math:`\tau_{\text{syn, ex}}` Rise time of the excitatory synaptic alpha function
``tau_syn_in`` ms :math:`\tau_{\text{syn, in}}` Rise time of the inhibitory synaptic alpha function
``I_e`` pA :math:`I_\text{e}` Constant input current
``V_min`` mV :math:`V_{\text{min}}` Absolute lower value for the membrane potenial (default :math:`-\infty`)
=============== ======== =============================== ========================================================================
=============== ================== =============================== ========================================================================
**Parameter** **Default** **Math equivalent** **Description**
=============== ================== =============================== ========================================================================
``E_L`` -70 mV :math:`E_\text{L}` Resting membrane potential
``C_m`` 250 pF :math:`C_{\text{m}}` Capacity of the membrane
``tau_m`` 10 ms :math:`\tau_{\text{m}}` Membrane time constant
``t_ref`` 2 ms :math:`t_{\text{ref}}` Duration of refractory period
``V_th`` -55 mV :math:`V_{\text{th}}` Spike threshold
``V_reset`` -70 mV :math:`V_{\text{reset}}` Reset potential of the membrane
``tau_syn_ex`` 2 ms :math:`\tau_{\text{syn, ex}}` Rise time of the excitatory synaptic alpha function
``tau_syn_in`` 2 ms :math:`\tau_{\text{syn, in}}` Rise time of the inhibitory synaptic alpha function
``I_e`` 0 pA :math:`I_\text{e}` Constant input current
``V_min`` :math:`-\infty` mV :math:`V_{\text{min}}` Absolute lower value for the membrane potenial (default :math:`-\infty`)
=============== ================== =============================== ========================================================================

The following state variables evolve during simulation and are available either as neuron properties or as recordables.

================== ================= ========================== =================================
**State variable** **Initial value** **Math equivalent** **Description**
================== ================= ========================== =================================
``V_m`` -70 mV :math:`V_{\text{m}}` Membrane potential
``I_syn_ex`` 0 pA :math:`I_{\text{syn, ex}}` Excitatory synaptic input current
``I_syn_in`` 0 pA :math:`I_{\text{syn, in}}` Inhibitory synaptic input current
================== ================= ========================== =================================


References
++++++++++
Expand Down