Skip to content

Commit

Permalink
Merge pull request #1043 from clinssen/doc_typos
Browse files Browse the repository at this point in the history
Fix typos and links in documentation pages
  • Loading branch information
clinssen committed Apr 25, 2024
2 parents abffcea + db4bbb1 commit 097ab79
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions doc/nestml_language/neurons_in_nestml.rst
Expand Up @@ -10,11 +10,11 @@ Modeling neurons in NESTML
Writing the NESTML model
########################

The top-level element of the model is ``neuron``, followed by a name. All other blocks appear inside of here.
The top-level element of the model is ``model``, followed by a name. All other blocks appear inside of here.

.. code-block:: nestml
neuron hodkin_huxley:
model hodkin_huxley_neuron:
# [...]
Neuronal interactions
Expand Down
4 changes: 2 additions & 2 deletions doc/nestml_language/synapses_in_nestml.rst
Expand Up @@ -23,11 +23,11 @@ Note that the synaptic strength ("weight") variable is of type real; if the type
Writing the NESTML model
########################

The top-level element of the model is ``synapse``, followed by a name. All other blocks appear inside of here.
The top-level element of the model is ``model``, followed by a name. All other blocks appear inside of here.

.. code-block:: nestml
synapse stdp:
model stdp_synapse:
# [...]
Input and output ports
Expand Down
12 changes: 6 additions & 6 deletions doc/running/running_nest_compartmental.rst
Expand Up @@ -23,7 +23,7 @@ One variable in the model represents the local membrane potential in a compartme

.. code-block:: nestml
neuron <neuron_name>:
model <neuron_name>:
state:
v_comp real = 0 # rhs value is irrelevant
Expand All @@ -35,7 +35,7 @@ Next, define one or more channels. An ion-channel is described in the following

.. code-block:: nestml
neuron <neuron_name>:
model <neuron_name>:
equations:
inline <current_equation_name> real = \
<some equation based on state variables, parameters, membrane potential and other equation names> \
Expand All @@ -49,7 +49,7 @@ As an example for a HH-type channel:

.. code-block:: nestml
neuron <neuron_name>:
model <neuron_name>:
parameters:
gbar_Ca_HVA real = 0.00
e_Ca_HVA real = 50.00
Expand Down Expand Up @@ -89,15 +89,15 @@ The concentration-model description looks very similar:

.. code-block:: nestml
neuron <neuron_name>:
model <neuron_name>:
equations:
<some_state_variable>' = <ODE right-hand-side for some_state_variable> @mechanism::concentration
As an example a description of a calcium concentration model where we pretend that we have the Ca_HVA and the Ca_LVAst ion-channels defined:

.. code-block:: nestml
neuron <neuron_name>:
model <neuron_name>:
state:
c_Ca real = 0.0001
Expand All @@ -120,7 +120,7 @@ Here synapse models are based on convolutions over a buffer of incoming spikes.

.. code-block:: nestml
neuron <neuron_name>:
model <neuron_name>:
equations:
inline <current_equation_name> real = \
<some equation based on state variables, parameters, membrane potential and other equation names \
Expand Down
10 changes: 5 additions & 5 deletions doc/tutorials/inhomogeneous_poisson/inhomogeneous_poisson.ipynb
Expand Up @@ -14,12 +14,12 @@
},
{
"cell_type": "markdown",
"id": "baebb161-bf56-4b3e-a487-512a67883ce6",
"id": "5109ab08-018d-40c6-b1b6-a383a22bdeb7",
"metadata": {},
"source": [
"## Preliminaries\n",
"\n",
"The inhomogeneous Poisson model is defined in the file ``inhomogeneous_poisson.nestml``. We call NESTML to generate and build the code, so the model can be instantiated in NEST Simulator."
"The inhomogeneous Poisson model is defined in the file [inhomogeneous_poisson.nestml](https://github.com/nest/nestml/blob/master/doc/tutorials/inhomogeneous_poisson/inhomogeneous_poisson.nestml). We call NESTML to generate and build the code, so the model can be instantiated in NEST Simulator."
]
},
{
Expand All @@ -44,8 +44,8 @@
" -- N E S T --\n",
" Copyright (C) 2004 The NEST Initiative\n",
"\n",
" Version: 3.5.0-rc1\n",
" Built: Feb 21 2024 09:04:08\n",
" Version: 3.6.0-post0.dev0\n",
" Built: Mar 26 2024 08:52:51\n",
"\n",
" This program is provided AS IS and comes with\n",
" NO WARRANTY. See the file LICENSE for details.\n",
Expand Down Expand Up @@ -299,7 +299,7 @@
"source": [
"## Simulating the models\n",
"\n",
"With the NESTML model loaded into the NEST kernel, we are ready to run the simulation. We define a helper function to run the simulation for each model: the NEST built-in inhomogeneous Poisson generator, and the one created in NESTML. We simulate ``n_instances`` (default: 100) of each model and compute the achieved average rate based on the simulation. The rates from the simulation (plotted below in red) should match the target rates (in blue). Events (spikes) emitted from eac model are additionally plotted in a rastergram."
"With the NESTML model loaded into the NEST kernel, we are ready to run the simulation. We define a helper function to run the simulation for each model: the NEST built-in inhomogeneous Poisson generator, and the one created in NESTML. We simulate ``n_instances`` (default: 100) of each model and compute the achieved average rate based on the simulation. The rates from the simulation (plotted below in red) should match the target rates (in blue). Events (spikes) emitted from each model are additionally plotted in a rastergram."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/stdp_dopa_synapse/stdp_dopa_synapse.ipynb
Expand Up @@ -8785,7 +8785,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Citations\n",
"Citations\n",
"---------\n",
"\n",
"[1] Mikaitis M, Pineda García G,\n",
Expand Down

0 comments on commit 097ab79

Please sign in to comment.