clean up model docstring syntax and add stdsp_synapse to models library (#1270)

clinssen · web-flow · commit c1cc471deec1 · 2026-01-05T17:05:57.000+01:00
diff --git a/doc/models_library/index.rst b/doc/models_library/index.rst
@@ -498,3 +498,11 @@ Source file: `stdp_synapse.nestml <https://www.github.com/nest/nestml/blob/maste
 Synapse type with triplet spike-timing dependent plasticity
 
 Source file: `stdp_triplet_synapse.nestml <https://www.github.com/nest/nestml/blob/master/models/synapses/stdp_triplet_synapse.nestml>`_
+
+
+:doc:`stdsp_synapse <stdsp_synapse>`
+------------------------------------
+
+Synapse model for spike-timing dependent plasticity with postsynaptic third-factor modulation
+
+Source file: `stdsp_synapse.nestml <https://www.github.com/nest/nestml/blob/master/models/synapses/stdsp_synapse.nestml>`_
diff --git a/models/neurons/aeif_cond_alpha_neuron.nestml b/models/neurons/aeif_cond_alpha_neuron.nestml
@@ -66,7 +66,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model aeif_cond_alpha_neuron:
 
     state:
diff --git a/models/neurons/aeif_cond_exp_neuron.nestml b/models/neurons/aeif_cond_exp_neuron.nestml
@@ -67,7 +67,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model aeif_cond_exp_neuron:
 
     state:
diff --git a/models/neurons/hh_cond_exp_destexhe_neuron.nestml b/models/neurons/hh_cond_exp_destexhe_neuron.nestml
@@ -50,7 +50,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model hh_cond_exp_destexhe_neuron:
 
     state:
diff --git a/models/neurons/hh_cond_exp_traub_neuron.nestml b/models/neurons/hh_cond_exp_traub_neuron.nestml
@@ -67,7 +67,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model hh_cond_exp_traub_neuron:
 
     state:
diff --git a/models/neurons/hh_moto_5ht_neuron.nestml b/models/neurons/hh_moto_5ht_neuron.nestml
@@ -50,7 +50,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model hh_moto_5ht_neuron:
     state:
         V_m mV = V_m_init    # Membrane potential
diff --git a/models/neurons/hh_psc_alpha_neuron.nestml b/models/neurons/hh_psc_alpha_neuron.nestml
@@ -63,7 +63,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model hh_psc_alpha_neuron:
     state:
         V_m mV = V_m_init    # Membrane potential
diff --git a/models/neurons/hill_tononi_neuron.nestml b/models/neurons/hill_tononi_neuron.nestml
@@ -54,7 +54,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model hill_tononi_neuron:
     state:
         potassium_refr_t ms = 0 ms
diff --git a/models/neurons/iaf_chxk_2008_neuron.nestml b/models/neurons/iaf_chxk_2008_neuron.nestml
@@ -54,7 +54,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_chxk_2008_neuron:
 
     state:
diff --git a/models/neurons/iaf_cond_alpha_neuron.nestml b/models/neurons/iaf_cond_alpha_neuron.nestml
@@ -55,7 +55,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_cond_alpha_neuron:
     state:
         V_m mV = E_L    # Membrane potential
diff --git a/models/neurons/iaf_cond_beta_neuron.nestml b/models/neurons/iaf_cond_beta_neuron.nestml
@@ -63,7 +63,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_cond_beta_neuron:
     state:
         V_m mV = E_L    # Membrane potential
diff --git a/models/neurons/iaf_cond_exp_neuron.nestml b/models/neurons/iaf_cond_exp_neuron.nestml
@@ -45,7 +45,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_cond_exp_neuron:
 
     state:
diff --git a/models/neurons/iaf_cond_exp_sfa_rr_neuron.nestml b/models/neurons/iaf_cond_exp_sfa_rr_neuron.nestml
@@ -53,7 +53,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_cond_exp_sfa_rr_neuron:
 
     state:
diff --git a/models/neurons/iaf_psc_alpha_neuron.nestml b/models/neurons/iaf_psc_alpha_neuron.nestml
@@ -77,7 +77,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_psc_alpha_neuron:
 
     state:
diff --git a/models/neurons/iaf_psc_exp_htum_neuron.nestml b/models/neurons/iaf_psc_exp_htum_neuron.nestml
@@ -72,7 +72,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_psc_exp_htum_neuron:
     state:
         r_tot  integer = 0
diff --git a/models/neurons/iaf_psc_exp_neuron.nestml b/models/neurons/iaf_psc_exp_neuron.nestml
@@ -73,7 +73,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model iaf_psc_exp_neuron:
 
     state:
diff --git a/models/neurons/ignore_and_fire_neuron.nestml b/models/neurons/ignore_and_fire_neuron.nestml
@@ -40,7 +40,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 # 
-#
 model ignore_and_fire_neuron:
 
   state:
diff --git a/models/neurons/izhikevich_neuron.nestml b/models/neurons/izhikevich_neuron.nestml
@@ -56,7 +56,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model izhikevich_neuron:
     state:
         V_m mV = V_m_init         # Membrane potential
diff --git a/models/neurons/izhikevich_psc_alpha_neuron.nestml b/models/neurons/izhikevich_psc_alpha_neuron.nestml
@@ -56,7 +56,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model izhikevich_psc_alpha_neuron:
     state:
         V_m mV = -65 mV # Membrane potential
diff --git a/models/neurons/mat2_psc_exp_neuron.nestml b/models/neurons/mat2_psc_exp_neuron.nestml
@@ -63,7 +63,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model mat2_psc_exp_neuron:
     state:
         V_th_alpha_1 mV = 0 mV # Two-timescale adaptive threshold
diff --git a/models/neurons/terub_gpe_neuron.nestml b/models/neurons/terub_gpe_neuron.nestml
@@ -49,7 +49,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model terub_gpe_neuron:
     state:
         V_m mV = E_L #  Membrane potential
diff --git a/models/neurons/terub_stn_neuron.nestml b/models/neurons/terub_stn_neuron.nestml
@@ -45,7 +45,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model terub_stn_neuron:
     state:
         V_m mV = E_L    # Membrane potential
diff --git a/models/neurons/traub_cond_multisyn_neuron.nestml b/models/neurons/traub_cond_multisyn_neuron.nestml
@@ -45,7 +45,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model traub_cond_multisyn_neuron:
     state:
         V_m mV = -70. mV # Membrane potential
diff --git a/models/neurons/traub_psc_alpha_neuron.nestml b/models/neurons/traub_psc_alpha_neuron.nestml
@@ -40,7 +40,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model traub_psc_alpha_neuron:
     state:
         V_m mV = V_m_init    # Membrane potential
diff --git a/models/neurons/wb_cond_exp_neuron.nestml b/models/neurons/wb_cond_exp_neuron.nestml
@@ -46,7 +46,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model wb_cond_exp_neuron:
     state:
         V_m mV = E_L    # Membrane potential
diff --git a/models/neurons/wb_cond_multisyn_neuron.nestml b/models/neurons/wb_cond_multisyn_neuron.nestml
@@ -46,7 +46,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model wb_cond_multisyn_neuron:
     state:
         V_m mV = -65. mV # Membrane potential
diff --git a/models/synapses/neuromodulated_stdp_synapse.nestml b/models/synapses/neuromodulated_stdp_synapse.nestml
@@ -47,7 +47,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model neuromodulated_stdp_synapse:
     state:
         w real = 1. [[w >= 0]]
diff --git a/models/synapses/noisy_synapse.nestml b/models/synapses/noisy_synapse.nestml
@@ -27,7 +27,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model noisy_synapse:
     parameters:
         w real = 1     # Synaptic weight
diff --git a/models/synapses/static_synapse.nestml b/models/synapses/static_synapse.nestml
@@ -26,7 +26,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model static_synapse:
     parameters:
         w real = 1    # Synaptic weight
diff --git a/models/synapses/stdp_nn_pre_centered_synapse.nestml b/models/synapses/stdp_nn_pre_centered_synapse.nestml
@@ -72,7 +72,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model stdp_nn_pre_centered_synapse:
     state:
         w real = 1 [[w >= 0]]   # Synaptic weight
diff --git a/models/synapses/stdp_nn_restr_symm_synapse.nestml b/models/synapses/stdp_nn_restr_symm_synapse.nestml
@@ -65,7 +65,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model stdp_nn_restr_symm_synapse:
     state:
         w real = 1. [[w >= 0]]   # Synaptic weight
diff --git a/models/synapses/stdp_nn_symm_synapse.nestml b/models/synapses/stdp_nn_symm_synapse.nestml
@@ -70,7 +70,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model stdp_nn_symm_synapse:
     state:
         w real = 1 [[w >= 0]]    # Synaptic weight
diff --git a/models/synapses/stdp_triplet_synapse.nestml b/models/synapses/stdp_triplet_synapse.nestml
@@ -42,7 +42,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model stdp_triplet_synapse:
     state:
         w nS = 1 nS [[w >= 0 nS]]   # Synaptic weight
diff --git a/models/synapses/stdsp_synapse.nestml b/models/synapses/stdsp_synapse.nestml
@@ -10,6 +10,13 @@
 # References
 # ++++++++++
 #
+# .. [1] NESTML "sequence learning" tutorial https://nestml.readthedocs.io/en/latest/tutorials/sequence_learning/sequence_learning.html
+#
+# .. [2] Younes Bouhadjar. A brain inspired sequence learning algorithm and foundations of a memristive hardware implementation Younes Bouhadjar (PhD thesis, RWTH Aachen). https://doi.org/10.18154/RWTH-2023-03627
+#
+# .. [3] Bouhadjar Y, Wouters DJ, Diesmann M, Tetzlaff T (2022) Sequence learning, prediction, and replay in networks of spiking neurons. PLoS Comput Biol 18(6): e1010233. https://doi.org/10.1371/journal.pcbi.1010233
+#
+#
 # Copyright statement
 # +++++++++++++++++++
 #
@@ -30,7 +37,6 @@
 # You should have received a copy of the GNU General Public License
 # along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
 model stdsp_synapse:
     state:
         permanence real = 1.

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,6 @@`
`66`	`66`	`# You should have received a copy of the GNU General Public License`
`67`	`67`	`# along with NEST. If not, see <http://www.gnu.org/licenses/>.`
`68`	`68`	`#`
`69`		`-#`
`70`	`69`	`model aeif_cond_alpha_neuron:`
`71`	`70`
`72`	`71`	`state:`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,6 @@`
`67`	`67`	`# You should have received a copy of the GNU General Public License`
`68`	`68`	`# along with NEST. If not, see <http://www.gnu.org/licenses/>.`
`69`	`69`	`#`
`70`		`-#`
`71`	`70`	`model aeif_cond_exp_neuron:`
`72`	`71`
`73`	`72`	`state:`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,6 @@`
`50`	`50`	`# You should have received a copy of the GNU General Public License`
`51`	`51`	`# along with NEST. If not, see <http://www.gnu.org/licenses/>.`
`52`	`52`	`#`
`53`		`-#`
`54`	`53`	`model hh_cond_exp_destexhe_neuron:`
`55`	`54`
`56`	`55`	`state:`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@`
`63`	`63`	`# You should have received a copy of the GNU General Public License`
`64`	`64`	`# along with NEST. If not, see <http://www.gnu.org/licenses/>.`
`65`	`65`	`#`
`66`		`-#`
`67`	`66`	`model hh_psc_alpha_neuron:`
`68`	`67`	`state:`
`69`	`68`	`V_m mV = V_m_init # Membrane potential`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,6 @@`
`54`	`54`	`# You should have received a copy of the GNU General Public License`
`55`	`55`	`# along with NEST. If not, see <http://www.gnu.org/licenses/>.`
`56`	`56`	`#`
`57`		`-#`
`58`	`57`	`model hill_tononi_neuron:`
`59`	`58`	`state:`
`60`	`59`	`potassium_refr_t ms = 0 ms`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,6 @@`
`55`	`55`	`# You should have received a copy of the GNU General Public License`
`56`	`56`	`# along with NEST. If not, see <http://www.gnu.org/licenses/>.`
`57`	`57`	`#`
`58`		`-#`
`59`	`58`	`model iaf_cond_alpha_neuron:`
`60`	`59`	`state:`
`61`	`60`	`V_m mV = E_L # Membrane potential`