Skip to content

Commit 3e7d705

Browse files
authored
Improve "what is NESTML" phrasing in documentation (#1375)
1 parent e58f266 commit 3e7d705

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

doc/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Please make sure to have the latest conda version installed and to create a new
9696
Alternatively, NEST can also be installed from source in a conda environment. The instructions can be found `here <https://nest-simulator.readthedocs.io/en/stable/installation/condaenv_install.html#condaenv>`_.
9797

9898
After installing NESTML, the neuron and synapse models can be found in the path ``$HOME/miniforge3/envs/<env_name>/models`` and the tutorial notebooks can be found under ``$HOME/miniforge3/envs/<env_name>/doc/tutorials``.
99-
For more information on how to run NESTML, please refer to `Running NESTML <https://nestml.readthedocs.io/en/latest/running/index.html>`_.
99+
For more information on how to run NESTML, please refer to :ref:`Running NESTML`.
100100

101101

102102
Docker installation

doc/nestml_language/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ NESTML language documentation
88
neurons_in_nestml
99
synapses_in_nestml
1010

11-
NESTML is a domain specific language for the specification of models; typically, the individual neurons and synapses that make up a neural network. NESTML is a completely generic language for hybrid dynamical systems, that is, those that exhibit continuous-time dynamics (such as described by ordinary differential equations) as well as instantaneous events. It is agnostic of the numerical methods used for simulating the model, such as which numerical (ODE) solver is used; this is determined during code generation and will typically depend on which simulation platform is used (for instance, NEST Simulator).
11+
NESTML is a domain-specific language for the specification of hybrid dynamical systems: those that combine continuous-time dynamics, often expressed as ordinary differential equations (ODEs), with discrete-time dynamics, which model instantaneous events such as neuronal spikes. NESTML was originally developed as a modelling language for the individual neurons and synapses that constitute a neural network, but is a completely generic language for any hybrid dynamical system. The language is agnostic about the numerical methods used for simulating the model, such as which numerical (ODE) solver is used; this is instead determined when code is generated for the model (see the section :ref:`Running NESTML`).
1212

13-
NESTML has a concise syntax based on that of Python, which avoids clutter in the form of semicolons, curly braces or tags as known from other programming and description languages. NESTML model files are expected to have the filename extension ``.nestml``. Each file may contain one or more models. This means that there is not necessarily a direct correspondence between model and file name; however, this is often done by convention.
13+
NESTML has a concise syntax based on that of Python, and is indentation-based, which avoids clutter in the form of semicolons, curly braces or tags. NESTML model files are expected to have the filename extension ``.nestml``. Each file may contain one or more models. This means that there is not necessarily a direct correspondence between model and file name; however, this is often done by convention.

doc/sphinx-apidoc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ The NESTML modeling language
1313
:align: right
1414
:target: nestml_language/synapses_in_nestml.html
1515

16-
NESTML is a domain-specific language for neuron and synapse models. These dynamical models can be used in simulations of brain activity on several platforms, in particular the `NEST Simulator <https://nest-simulator.readthedocs.org/>`_.
16+
NESTML is a domain-specific language for hybrid dynamical systems, in particular neuron and synapse models. The toolchain automatically generates code for these models, allowing them to be used in brain simulations on several platforms (see :ref:`Running NESTML`).
1717

1818
NESTML combines:
1919

2020
- an easy to understand, yet powerful syntax;
2121
- a flexible processing toolchain, written in Python;
2222
- good simulation performance by means of code generation (C++ for NEST Simulator).
2323

24-
To see what NESTML looks like, please see the :doc:`models library <models_library/index>`. The library contains a variety of models from standard integrate-and-fire to a family of biophysical, Hodgkin-Huxley type neurons, as well as several synaptic plasticity models such as spike-timing dependent plasticity (STDP) variants and third-factor plasticity rules.
24+
To see what the NESTML language looks like, please see the :doc:`models library <models_library/index>`. The library contains a variety of models from standard integrate-and-fire to a family of biophysical, Hodgkin-Huxley-type neurons, as well as several synaptic plasticity models such as spike-timing-dependent plasticity (STDP) variants and third-factor plasticity rules.
2525

2626
:doc:`PyNESTML <pynestml_toolchain/index>` is the Python-based toolchain for the NESTML language: it parses the model and performs code generation. Modify PyNESTML to add language elements such as new predefined functions, or to add new target platforms in the form of `Jinja <https://jinja.palletsprojects.com>`_ templates.
2727

0 commit comments

Comments
 (0)