Modify doc index page

doc/htmldoc/attribution-list.rst

@@ -1,4 +1,16 @@
-:orphan: 
+:orphan:
+
+
+The following images were created by A. Fischer - INM-6 Forschungszentrum Juelich GmBH
+
+Cite the author of the work if using in NEST project.
+
+* neuron.svg
+* synapse.svg
+* networkbrainlight.svg
+* stimulatelight.svg
+* recordinglight.svg
+
 
 Icons provided by Flaticon
 --------------------------
@@ -15,7 +27,7 @@ Icons provided by Flaticon
 <a href="https://www.flaticon.com/free-icons/brain" title="brain icons">Brain icons created by Freepik - Flaticon</a>
 <a href="https://www.flaticon.com/free-icons/teacher" title="teacher icons">Teacher icons created by Good Ware - Flaticon</a>
 <a href="https://www.flaticon.com/free-icons/math" title="math icons">Math icons created by Freepik - Flaticon</a>
-<a href="https://www.flaticon.com/free-icons/data-storage" title="data storage icons">Data storage icons created by IconLauk - Flaticon</a> 
+<a href="https://www.flaticon.com/free-icons/data-storage" title="data storage icons">Data storage icons created by IconLauk - Flaticon</a>
 <a href="https://www.flaticon.com/free-icons/version" title="version icons">Version icons created by Ahmad Roaayala - Flaticon</a>
 <a href="https://www.flaticon.com/free-icons/developer" title="developer icons">Developer icons created by Freepik - Flaticon</a>
 <a href="https://www.flaticon.com/free-icons/cloud-computing" title="cloud computing icons">Cloud computing icons created by Prosymbols Premium - Flaticon</a>
@@ -26,3 +38,5 @@ Icons provided by Flaticon
 <a href="https://www.flaticon.com/free-icons/quote" title="quote icons">Quote icons created by DinosoftLabs - Flaticon</a>
 <a href="https://www.flaticon.com/free-icons/mail" title="mail icons">Mail icons created by Freepik - Flaticon</a>
 <a href="https://www.flaticon.com/free-icons/external-link" title="external link icons">External link icons created by Bharat Icons - Flaticon</a>
+<a href="https://www.flaticon.com/free-icons/checklist" title="checklist icons">Checklist icons created by juicy_fish - Flaticon</a>
+<a href="https://www.flaticon.com/free-icons/scientist" title="scientist icons">Scientist icons created by Victoruler - Flaticon</a>

doc/htmldoc/conf.py

@@ -53,26 +53,27 @@
     "sphinx.ext.intersphinx",
     "sphinxcontrib.mermaid",
     "sphinx.ext.mathjax",
+    "sphinx_carousel.carousel",
     "sphinxcontrib.plantuml",
     "add_button_notebook",
     "IPython.sphinxext.ipython_console_highlighting",
     "nbsphinx",
     "extract_api_functions",
     "sphinx_design",
-    "HoverXTooltip",
     "VersionSyncRole",
+    "HoverXTooltip",
     "sphinx_copybutton",
     "notfound.extension",
 ]
 
 autodoc_mock_imports = ["nest.pynestkernel", "nest.ll_api"]
 mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
-panels_add_bootstrap_css = False
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["templates"]
 
 # To run plantuml locally see the user documentation workflow
 plantuml = "java -jar /tmp/plantuml.jar"
+plantuml_output_format = "svg_img"
 sphinx_gallery_conf = {
     # path to your examples scripts
     "examples_dirs": "../../pynest/examples",
@@ -82,6 +83,9 @@
     "download_all_examples": False,
 }
 
+carousel_show_captions_below = True
+# carousel_show_controls = True
+
 # General information about the project.
 project = "NEST Simulator user documentation"
 copyright = "2004, nest-simulator"
@@ -177,7 +181,18 @@
 }
 
 html_static_path = ["static"]
-html_additional_pages = {"index": "index.html"}
+
+html_css_files = [
+    "css/custom.css",
+    "css/popup.css",
+    "css/pygments.css",
+]
+
+html_js_files = [
+    "js/custom.js",
+    "js/popup.js",
+]
+# html_additional_pages = {"index": "index.html"}
 html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]}
 
 html_favicon = "static/img/nest_favicon.ico"
@@ -230,9 +245,6 @@ def setup(app):
     # for events see
     # https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events
     app.connect("source-read", toc_customizer)
-    app.add_css_file("css/custom.css")
-    app.add_css_file("css/pygments.css")
-    app.add_js_file("js/custom.js")
     app.connect("config-inited", config_inited_handler)
 
 

doc/htmldoc/get-started_index.rst

@@ -1,28 +1,31 @@
-Tutorials and examples
-======================
+Tutorials and guides
+====================
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
    tutorials/index
-   PyNEST example scripts <examples/index>
+
 
 
 .. grid:: 1 1 2 2
     :gutter: 1
 
-    .. grid-item-card:: |nav| Tutorials
+    .. grid-item-card:: |nav| Tutorials: Introduction to PyNEST
        :class-title: sd-d-flex-row sd-align-minor-center
        :link: tutorials
        :link-type: ref
 
-    .. grid-item-card:: |example| PyNEST example scripts
+    .. grid-item-card:: |example| Topical guides
        :class-title: sd-d-flex-row sd-align-minor-center
-       :link: pynest_examples
+       :link: guides
        :link-type: ref
 
+.. toctree::
+   :hidden:
 
+   understand_index
 
-.. |nav| image:: static/img/GPS-Settings-256_nest.svg 
+.. |nav| image:: static/img/GPS-Settings-256_nest.svg
 .. |example| image::  static/img/Documents-02-256_nest.svg

doc/htmldoc/index.rst

@@ -1,16 +1,177 @@
-NEST Simulator documentaiton
+NEST Simulator documentation
 ============================
 
+
+Welcome!
+--------
+
+
+.. grid::
+
+  .. grid-item::
+
+    NEST is used in computational neuroscience to model and study behavior of large networks of neurons.
+
+    The models describe single neuron and synapse behavior and their connections.
+    Different mechanisms of plasticity can be used to investigate artificial learning
+    and help to shed light on the fundamental principles of how the brain works.
+
+    NEST offers convenient and efficient commands to define and connect large networks,
+    ranging from algorithmically determined connections to data-driven connectivity.
+    Create connections between neurons using numerous synapse models from STDP to gap junctions.
+
+    .. button-ref:: tutorials_guides
+       :ref-type: ref
+       :shadow:
+       :color: primary
+
+       Get started with NEST
+
+  .. grid-item::
+
+     .. grid:: 1 1 1 1
+       :gutter: 2
+
+       .. grid-item-card::
+
+          .. carousel::
+              :show_controls:
+              :show_fade:
+              :data-bs-ride: carousel
+
+                .. figure:: static/img/pong_sim.gif
+
+                  Play PONG with NEST
+
+                .. figure:: static/img/pynest/spatial_test3d.png
+
+                  Create 3D spatially structured networks
+
+
+                .. figure:: static/img/astrocyte_interaction.png
+
+                  Investigate neuron and astrocyte interactions
+
+
+       .. grid-item::
+
+          .. button-ref:: pynest_examples
+             :ref-type: ref
+             :color: info
+             :align: center
+             :shadow:
+
+             Click here to discover all our examples!
+
+----
+
+Conceptual approach
+-------------------
+
+
+.. mermaid::
+
+   %%{
+     init:{
+       "theme": "base",
+       "themeVariables": {
+          "lineColor": "#f63",
+          "fontSize" : "18px"
+       }
+     }
+    }%%
+   flowchart LR
+
+     classDef nodeStyle color:#fff, stroke:#fff0, fill:#0E6A93;
+     classDef nodeStyle2 color:#000, stroke:#fff0, fill:#072f4200;
+     classDef nodeStyle3 color:#222, stroke:#fff0, fill:#bbb0;
+
+     exp --> nest-simulator
+     models -->nest-simulator
+     nest-simulator --> act
+
+     subgraph  exp [Experimental protocols]
+      ir:::nodeStyle3
+     end
+     subgraph nest-simulator [nest-simulator]
+       direction TB
+       stimulating_devices:::nodeStyle2 --> simulate
+       simulate:::nodeStyle2 --> recording_devices:::nodeStyle2
+     end
+
+     subgraph models [Built-in or user provided models]
+        direction LR
+        neuron_models:::nodeStyle --> network:::nodeStyle
+        synapse_models:::nodeStyle --> network
+
+     end
+     subgraph act [Activity data]
+       smp:::nodeStyle3
+     end
+
+     class act sg
+     class exp sg
+     class models bg_models
+     class nest-simulator bg_devices
+     classDef sg fill:#bbb4, stroke:#4441, color:#111;
+     classDef bg_models fill:#bbb7, stroke:#3330, color:#000, font-weight: bold;
+     classDef bg_devices fill:#bbb7, stroke:#3330, color:#000, font-weight: bold;
+
+   %% Note that the spaces used in the "Simulation" text are the copy pasted unicode space character.
+   %% HTML spaces like %emsp; do not work
+   simulate(<img src="_static/img/nest_logo.png"/>     Simulation     \n)
+   neuron_models(<img src="_static/img/neuron.svg" /> \n  Neuron Models)
+   synapse_models(<img src="_static/img/synapse.svg" /> \n Synapse Models )
+   stimulating_devices(<img src="_static/img/stimulatelight.svg" /> Stimulating Devices)
+   recording_devices(<img src="_static/img/recordinglight.svg" />  Recording Devices )
+   network(<img src="_static/img/networkbrainlight.svg" /> \n  Network  Models )
+   smp(<img src="_static/img/pynest/mc_neuron_sm.png" /> \n spike membrane potential, \n synaptic weights, etc.)
+   ir(<img src="_static/img/experiment.png"/> \n Input rates, input currents, \n timed sequences, etc.)
+   click network href "./networks/index.html"
+   click neuron_models href "./models/index_neuron.html"
+   click synapse_models href "./models/index_synapse.html"
+   click stimulating_devices href "./models/index_generator.html"
+   click recording_devices href "./models/index_device.html"
+   click simulate href "./nest_behavior/running_simulations.html"
+
+
+
+
 .. toctree::
-   :maxdepth: 1
+   :caption: USAGE
    :hidden:
+   :glob:
 
-   Installation <installation/index>
-   Tutorials and examples <get-started_index>
-   Understand how NEST works <understand_index>
-   PyNEST API <ref_material/pynest_api/index>
+   Install <installation/index>
+   Tutorials and Guides <get-started_index>
+   Examples <examples/index>
    Available models <models/index>
+   PyNEST API <ref_material/pynest_api/index>
+   ref_material/glossary
+
+
+.. toctree::
+   :caption: COMMUNITY
+   :hidden:
+   :glob:
+
+   Cite NEST <citing-nest>
+   Contact us <community>
    Contribute <developer_space/index>
    What's new? <whats_new/index>
-   Community <community>
+   NEST Homepage <https://nest-simulator.org>
+
+.. toctree::
+   :caption: RELATED PROJECTS
+   :hidden:
+
+   NEST Desktop <https://nest-desktop.readthedocs.io/en/latest/>
+   NESTML <https://nestml.readthedocs.io/en/latest/>
+   NESTGPU <https://nestgpu.readthedocs.io/en/latest/>
+
+.. toctree::
+   :maxdepth: 1
+   :caption: LICENSE
+   :hidden:
+
    license