Skip to content

Add detailed neuron documentation #3448

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.

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

Open
wants to merge 58 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
531076b
add neuron types and restructure
jessica-mitchell Jun 18, 2024
30717bb
add svgs
jessica-mitchell Jun 18, 2024
b4e490f
update css
jessica-mitchell Jun 18, 2024
773368f
try smaller images
jessica-mitchell Jun 19, 2024
3b19f22
update images
jessica-mitchell Jun 21, 2024
292c14a
minor fixes
jessica-mitchell Jun 21, 2024
c204ad0
update images, and text
jessica-mitchell Jun 24, 2024
19fc7de
update text
jessica-mitchell Jun 26, 2024
c002583
update text
jessica-mitchell Jun 26, 2024
a15585b
move to separate page
jessica-mitchell Jun 27, 2024
3dba390
update images
jessica-mitchell Jun 27, 2024
08d9351
move to new page
jessica-mitchell Jun 27, 2024
1362c29
add jinja template comment
jessica-mitchell Jun 27, 2024
05d8333
Merge branch 'master' into neuron-docs
jessica-mitchell Jun 27, 2024
bade9e9
minor fixes
jessica-mitchell Jul 2, 2024
4b7b0d2
add neuron_state
jessica-mitchell Jul 22, 2024
eb77b13
test images
jessica-mitchell Jul 31, 2024
5fa7fd6
new synapse desc, neuron updates
jessica-mitchell Aug 6, 2024
2d13d26
Merge branch 'master' into neuron-docs
jessica-mitchell Aug 12, 2024
def4753
some text updates
jessica-mitchell Aug 13, 2024
f97cc36
move rate transforer away from opn ipn
jessica-mitchell Aug 26, 2024
5e54782
fix text
jessica-mitchell Sep 9, 2024
f0bd5f9
update
jessica-mitchell Oct 7, 2024
10f9c56
udpatews
jessica-mitchell Oct 8, 2024
be951e4
update flowchart neuron docs
jessica-mitchell Oct 24, 2024
9b7865a
fix mermaid
jessica-mitchell Oct 24, 2024
c03a217
add link
jessica-mitchell Oct 25, 2024
f9a5ffb
add link
jessica-mitchell Nov 5, 2024
1a6f724
update text
jessica-mitchell Nov 19, 2024
a8384b4
modify text
jessica-mitchell Dec 9, 2024
53a7a5a
update
jessica-mitchell Dec 10, 2024
5c75e7b
more updates
jessica-mitchell Dec 10, 2024
a0e406a
changes from DDahmen
jessica-mitchell Dec 11, 2024
de6788b
add toms suggestions synapse_dynamics
jessica-mitchell Dec 12, 2024
b76812b
add syanpse plasticiy model rephrasing index
jessica-mitchell Dec 19, 2024
697c664
add categories to models
jessica-mitchell Feb 3, 2025
0c340ad
update script
jessica-mitchell Feb 3, 2025
006df89
update text and math
jessica-mitchell Feb 3, 2025
6dbc716
Merge branch 'master' into neuron-docs
jessica-mitchell Feb 3, 2025
b14855d
add image
jessica-mitchell Feb 3, 2025
a343dba
update templates
jessica-mitchell Feb 3, 2025
3736ec1
fix math
jessica-mitchell Feb 6, 2025
da22d9c
update flowchart
jessica-mitchell Mar 13, 2025
94ad52e
Merge branch 'master' into neuron-docs
jessica-mitchell Mar 13, 2025
5274c8e
add images, update flowchart with colour
jessica-mitchell Mar 18, 2025
422ce8a
update neuron update page
jessica-mitchell Mar 18, 2025
1b52be3
minor edits
jessica-mitchell Mar 18, 2025
755187f
update according Tom/David
jessica-mitchell Mar 20, 2025
61b1133
Merge branch 'master' into neuron-docs
jessica-mitchell Mar 20, 2025
5f4bac5
minor tweaks?
jessica-mitchell Mar 25, 2025
6eac624
update image
jessica-mitchell Mar 27, 2025
f95bde3
rm synapse dynamics - for another pr - rm links
jessica-mitchell Mar 27, 2025
8339dba
rm synapsedyn from get-started
jessica-mitchell Mar 27, 2025
63acb11
rm exec times
jessica-mitchell Mar 27, 2025
8b8649e
remove ununsed images
jessica-mitchell Mar 27, 2025
d2fdbc1
readd images, update paths
jessica-mitchell Mar 27, 2025
2e0fede
rm img
jessica-mitchell Mar 27, 2025
e4f62bf
rm img2
jessica-mitchell Mar 27, 2025
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
2 changes: 1 addition & 1 deletion doc/htmldoc/_ext/model_tag_setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ def template_renderer(app, docname, source):
and used to inject the rendered content.
"""
env = app.builder.env
template_files = ["models/index", "neurons/index", "synapses/index", "devices/index"]
template_files = ["models/index", "neurons/index", "synapses/index", "devices/index", "neurons/neuron_types"]

# Render the document if it matches one of the specified templates
if any(docname == template_file for template_file in template_files):
Expand Down
4 changes: 4 additions & 0 deletions doc/htmldoc/get-started_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ More topics
|neuron| More about neurons
^^^

* :ref:`types_neurons`
* :ref:`neuron_update`
* :ref:`sim_precise_spike_times`
* :ref:`exact_integration`

Expand Down Expand Up @@ -211,6 +213,8 @@ More topics

tutorials/index
tutorials/pynest_tutorial/index
neurons/neuron_update
neurons/neuron_types

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion doc/htmldoc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ How NEST works --- The Big Picture


A NEST simulation is created with input from :doc:`stimulation devices </devices/index>`,
:doc:`neuron models </neurons/index>`, and :doc:`synapse models </synapses/index>`,
:doc:`neuron models </neurons/index>`, and :doc:`synapstic plasticity models </synapses/index>`,
along with :ref:`connection rules <connectivity_concepts>`.
You can choose what data to record with :doc:`recording devices </devices/index>`.
After simulation, the output is ready for analysis with NEST's built in :py:mod:`.raster_plot` and :py:mod:`.voltage_trace`
Expand Down
6 changes: 1 addition & 5 deletions doc/htmldoc/models/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ Learn more about . . .
* :ref:`Model terminology <model_meaning>`



----

.. _model_meaning:
Expand All @@ -115,10 +114,7 @@ The term `models` in the context of NEST (and the field of computational neurosc
2. **Network models**. These models are created from individual neuron
and synapse models using the different commands provided by the
:ref:`PyNEST API <pynest_api>`. Examples for such network models
are the :doc:`microcircuit model
<../auto_examples/Potjans_2014/index>` or the `multi-area model
<https://inm-6.github.io/multi-area-model/>`_).
You can also explore :doc:`all our example networks </examples/index>`.
can be found :doc:`here </examples/index>`.

.. seealso::

Expand Down
1 change: 1 addition & 0 deletions doc/htmldoc/nest_behavior/running_simulations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ The simulation loop. Light gray boxes denote thread parallel parts, dark
gray boxes denote :hxt_ref:`MPI` parallel parts. U(St) is the update operator that
propagates the internal state of a neuron or device.


.. _simulation_resolution:

Simulation resolution and update interval
Expand Down
109 changes: 62 additions & 47 deletions doc/htmldoc/neurons/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,72 +4,87 @@ All about neurons in NEST
=========================


Guides on using neurons in NEST
-------------------------------

.. grid:: 1 1 2 2
.. grid:: 1 1 3 3
:gutter: 1

.. grid-item::
.. grid-item-card::
:class-header: sd-d-flex-row sd-align-minor-center sd-bg-info sd-text-white

.. grid:: 1 1 1 1

.. grid-item-card:: Node management (neurons and devices)
|neuron| Neuron types in NEST
^^^

* :ref:`node_handles`
* :ref:`param_ex`

.. grid-item::
* :ref:`types_neurons`: Find out about the various neuron models and their mechanisms that are available in NEST

.. grid:: 1 1 1 1
* :ref:`neuron_update`: Learn how NEST handles the steps to update the dynamics of neurons during simulation.

.. grid-item-card:: Exact integration
:class-title: sd-d-flex-row sd-align-minor-center
:link: exact_integration
:link-type: ref

.. grid-item-card:: Precise spike times
:class-title: sd-d-flex-row sd-align-minor-center
:link: sim_precise_spike_times
:link-type: ref
.. grid-item-card::
:class-header: sd-d-flex-row sd-align-minor-center sd-bg-info sd-text-white

.. toctree::
:maxdepth: 1
:glob:
:hidden:

*
|python| Using neurons in PyNEST scripts
^^^

* :ref:`Manipulating nodes (neurons and devices) <node_handles>`: understand basic functionality of nodes
* :ref:`param_ex`: explore how to use parameter objects in NEST


.. dropdown:: List of neuron models
:color: info
.. grid-item-card::
:class-header: sd-d-flex-row sd-align-minor-center sd-bg-info sd-text-white

{% for items in tag_dict %}
{% if items.tag == "neuron" %}
{% for item in items.models | sort %}
* :doc:`/models/{{ item | replace(".html", "") }}`
{% endfor %}
{% endif %}
{% endfor %}

|math| Find a specific model
^^^

Neuron model naming conventions
-------------------------------

Neuron model names in NEST combine abbreviations that describe the dynamics and synapse specifications for that model.
They may also include the author's name of a model based on a specific paper.
For details on individual models, please take alook at our model directory, where you can
select various tags and refine the results to your choosing, or look up our A-Z list.

For example, the neuron model name
* :doc:`/models/index`

``iaf_cond_beta``

corresponds to an implementation of a spiking neuron using
integrate-and-fire dynamics with conductance-based
synapses. Incoming spike events induce a postsynaptic change of
conductance modeled by a beta function.

As an example for a neuron model name based on specific paper,
----

``hh_cond_exp_traub``
.. |nav| image:: /static/img/GPS-Settings-256_nest.svg
.. |script| image:: /static/img/script_white.svg
:scale: 20%
.. |start| image:: /static/img/start_white.svg
:scale: 40%
.. |user| image:: /static/img/020-user.svg
.. |teacher| image:: /static/img/014-teacher.svg
.. |admin| image:: /static/img/001-shuttle.svg
.. |dev| image:: /static/img/dev_orange.svg
.. |nestml| image:: /static/img/nestml-logo.png
:scale: 15%
.. |synapse| image:: /static/img/synapse_white.svg
.. |neuron| image:: /static/img/neuron_white.svg
.. |glossary| image:: /static/img/glossary_white.svg
.. |git| image:: /static/img/git_white.svg
.. |refresh| image:: /static/img/refresh_white.svg
.. |hpc| image:: /static/img/hpc_white.svg
.. |random| image:: /static/img/random_white.svg
.. |math| image:: /static/img/math_white.svg
.. |network| image:: /static/img/network_brain_white.svg
.. |device| image:: /static/img/device_white.svg
.. |connect| image:: /static/img/connect_white.svg
.. |sonata| image:: /static/img/sonata_white.svg
.. |write| image:: /static/img/write_nest_white.svg
:scale: 60%
.. |parallel| image:: /static/img/parallel_white.svg
.. |simulate| image:: /static/img/simulate_white.svg
.. |interactive| image:: /static/img/interactive_white.svg
.. |python| image:: /static/img/python_white.svg
.. |gallery| image:: /static/img/gallery_white.svg


.. toctree::
:hidden:

implements a modified version of the Hodgkin Huxley neuron model
based on Traub and Miles (1991)
neuron_types
parametrization
node_handles
exact-integration
simulations_with_precise_spike_times
Loading
Loading