Skip to content

Improve discoverablility of network models in NEST docs #3428

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 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 8 additions & 4 deletions doc/htmldoc/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ PyNEST examples
===============

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

.. grid-item-card:: Simple networks
:img-top: ../static/img/pynest/mc_neuron.png
Expand Down Expand Up @@ -76,11 +77,13 @@ PyNEST examples
* :doc:`../auto_examples/brunel_alpha_evolution_strategies`


.. grid-item-card:: Cortical microcircuit (Potjans)
:img-top: ../auto_examples/Potjans_2014/potjans_2014_raster_plot.png

* :doc:`../auto_examples/Potjans_2014/index`
.. grid-item-card:: Large scale cortical network models
:img-top: ../static/img/network_model_sketch_mesocircuit.png

* :doc:`../auto_examples/Potjans_2014/index` (Potjans and Diesmann 2014)
* `The mesocircuit model <https://mesocircuit-model.readthedocs.io/en/latest/>`_: A layered cortical network with distance-dependent connectivity
* `The multi-area model <https://inm-6.github.io/multi-area-model/>`_: A network model of the visual cortex of the macaque monkey
* `The HuMAM model <https://github.com/INM-6/human-multi-area-model>`_: Multi-Scale Spiking Network Model of Human Cerebral Cortex


.. grid-item-card:: EI clustered network (Rostami et al)
Expand Down Expand Up @@ -161,6 +164,7 @@ PyNEST examples

* :doc:`../auto_examples/wang_decision_making`


.. grid:: 1 1 2 3

.. grid-item-card:: Gap junctions
Expand Down
2 changes: 1 addition & 1 deletion doc/htmldoc/get-started_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Next steps: Create your own network model
* :doc:`Brunel network </auto_examples/brunel_alpha_nest>`: A random balanced network
* :doc:`The microcircuit model <../auto_examples/Potjans_2014/index>`: A network model example based on Potjans and Diesman 2014
* `The mesocircuit model <https://mesocircuit-model.readthedocs.io/en/latest/>`_: A layered cortical network with distance-dependent connectivity
* The `multi-area model <https://inm-6.github.io/multi-area-model/>`_: A network model of the visual cortex of the macaque monkey
* `The multi-area model <https://inm-6.github.io/multi-area-model/>`_: A network model of the visual cortex of the macaque monkey



Expand Down
29 changes: 29 additions & 0 deletions doc/htmldoc/models/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,32 @@ Model directory
===============


What type of model?
-------------------

NEST has over 100 models, choose an option for finding the one you need!

.. grid::

.. grid-item-card::
:columns: 4
:link: network_models
:link-type: ref

**Network Models**



.. grid-item-card::
:columns: 4
:link: model_selector
:link-type: ref

**Neurons, synapses, and devices**




.. _model_selector:

Model selector
Expand Down Expand Up @@ -153,3 +177,8 @@ References
{% for keys in model_dict %}
{{ keys | replace(".html", "") }}
{% endfor %}

.. toctree::
:hidden:

../networks/index
47 changes: 47 additions & 0 deletions doc/htmldoc/networks/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.. _network_models:

Network Models
==============

Here we have several examples of large-scale network models developed for NEST.
You can see how to build other networks for various neuron, synapse and device types in our
:doc:`examples gallery </examples/index>`.


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

.. grid-item-card:: Brunel Network
:columns: 4
:link: /auto_examples/brunel_alpha_nest
:link-type: doc

A random balanced network

.. grid-item-card:: Microcircuit Model
:columns: 4
:link: /auto_examples/Potjans_2014/index
:link-type: doc

A network model example based on Potjans and Diesman 2014


.. grid-item-card:: Mesocircuit Model
:columns: 4
:link: https://mesocircuit-model.readthedocs.io/en/latest/

A layered cortical network with distance-dependent connectivity


.. grid-item-card:: Multi-area Model
:columns: 4
:link: https://inm-6.github.io/multi-area-model/

A network model of the visual cortex of the macaque monkey


.. grid-item-card:: HuMAM model
:columns: 4
:link: https://github.com/INM-6/human-multi-area-model

Multi-Scale Spiking Network Model of Human Cerebral Cortex
2 changes: 1 addition & 1 deletion doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading