diff --git a/doc/htmldoc/.gitignore b/doc/htmldoc/.gitignore index 930bfcce26..46c72e0e92 100644 --- a/doc/htmldoc/.gitignore +++ b/doc/htmldoc/.gitignore @@ -6,3 +6,4 @@ auto_examples/ static/examples # json data is produced at build time by Sphinx static/data/filter_model.json +sg_execution_times.rst diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index 7eb1ababea..cd0294f4db 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -22,6 +22,12 @@ Welcome to the NEST Simulator documentation! ranging from algorithmically determined connections to data-driven connectivity. Create connections between neurons using numerous synapse models from STDP to gap junctions. + To get started you can: + + ``pip install nest-simulator`` + + see :ref:`here ` for all installation options! + .. grid-item:: diff --git a/doc/htmldoc/installation/index.rst b/doc/htmldoc/installation/index.rst index 941aaa54fa..2c3806c22c 100644 --- a/doc/htmldoc/installation/index.rst +++ b/doc/htmldoc/installation/index.rst @@ -1,35 +1,46 @@ .. _install_nest: -Install NEST -============ +Install and run NEST +==================== - -.. grid:: 2 +.. grid:: :gutter: 1 - .. grid-item-card:: |user| Install a pre-built NEST package using - :class-title: sd-d-flex-row sd-align-minor-center - :columns: 4 - * :ref:`Docker (cross-platform) ` - (Includes NESTML) - * :ref:`conda-forge (Linux/macOS) ` - * :ref:`Ubuntu PPA (Linux) ` - * :ref:`Homebrew (macOS) ` - * :ref:`Options for Windows users ` + .. grid-item-card:: |user| I want to run NEST on my laptop + :class-title: sd-d-flex-row sd-align-minor-center + + You can ``pip install nest-simulator`` + + See our :ref`detailed instructions` including installing NEST with + |nestml| and |desktop|. + + .. dropdown:: Other options for pre-packaged NEST + :class-title: sd-font-weight-light sd-fs-7 sd-text-secondary + :class-container: sd-align-major-center + :color: light + * :ref:`Docker (cross-platform) ` + (Includes NESTML) + * :ref:`conda-forge (Linux/macOS) ` + * :ref:`Ubuntu PPA (Linux) ` + * :ref:`Homebrew (macOS) ` + * :ref:`Options for Windows users ` - .. grid-item-card:: |dev| Source install + .. grid-item-card:: |dev| I want to do development with NEST :class-title: sd-d-flex-row sd-align-minor-center - :columns: 4 - If you want to do development with NEST + For customizing the build (e.g., adding MPI support), you can * :ref:`dev_install` - .. grid-item-card:: |launch| Try NEST installation-free + +.. grid:: + :gutter: 1 + + + .. grid-item-card:: |launch| I want to try out NEST without installing anything :class-title: sd-d-flex-row sd-align-minor-center - :columns: 4 With the JupyterHub service from EBRAINS, you can try out NEST (and many other tools) directly in your browser. @@ -42,48 +53,51 @@ Install NEST * For more info see :ref:`our guide to running Jupyter notebooks on EBRAINS ` -Install related tools -~~~~~~~~~~~~~~~~~~~~~ -.. grid:: 2 - :gutter: 1 - - .. grid-item-card:: |desktop| + .. grid-item-card:: |teach| I want to use NEST in the classroom/for a workshop :class-title: sd-d-flex-row sd-align-minor-center - :columns: 4 - A graphical user interface, ideal for learning and teaching concepts + + Use |desktop| - + a graphical user interface, ideal for learning and teaching concepts regarding neural networks in classrooms and workshops. - * :doc:`NEST Desktop documentation ` :octicon:`link-external` + * :doc:`Lecturer guide ` + * :ref:`Introduction to PyNEST tutorial ` + * :doc:`NESTML tutorials ` - * :ref:`Install docker container with NEST + NEST Desktop ` - .. grid-item-card:: |nestml| - :class-title: sd-d-flex-row sd-align-minor-center - :columns: 4 - Install the NEST modeling language to create and customize models +.. grid:: + :gutter: 1 + .. grid-item-card:: |hpc| I want to run NEST on an HPC system + :class-title: sd-d-flex-row sd-align-minor-center + :columns: 6 - * :doc:`NESTML documentation ` :octicon:`link-external` + We have provided some helpful guides to understanding and optimizing NEST + in HPC environments: - * :ref:`Install docker container for NEST + NESTML ` + * :ref:`optimize_performance` + * :ref:`parallel_computing` - .. grid-item-card:: |hpc| Configure HPC systems - :class-title: sd-d-flex-row sd-align-minor-center - :columns: 4 +What's next? +------------- - Find out how to set up and optimize HPC systems for NEST - * :ref:`optimize_performance` +.. grid:: + :gutter: 1 + .. grid-item-card:: + :columns: 6 + See our :ref:`tutorials and guides ` to get started with NEST + or + explore are vast catalog of :ref:`examples `. ---- - If installation didn't work, see the :ref:`troubleshooting section `. @@ -101,5 +115,10 @@ If installation didn't work, see the :ref:`troubleshooting section *{ width: 85%; }