Skip to content
Merged
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
18 changes: 10 additions & 8 deletions doc/htmldoc/installation/docker.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _docker:

Docker |macos| |linux| |windows|
--------------------------------
Docker |macos| |linux|
----------------------

Docker provides an isolated container to run applications.

Expand All @@ -27,7 +27,7 @@ Docker provides an isolated container to run applications.
Usage


You can use the docker images directly out of https://hub.docker.com/r/nest/nest-simulator
You can use the docker images directly out of https://hub.docker.com/r/nest/nest-simulator
like this:

.. code-block:: bash
Expand Down Expand Up @@ -144,10 +144,12 @@ If you want to use the compose configuration for the ``dev`` NEST version, you c
wget https://raw.githubusercontent.com/nest/nest-docker/master/docker-compose-dev.yml
docker-compose -f docker-compose-dev.yml up nest-notebook

On Windows
^^^^^^^^^^
.. _docker_win:

.. note::
Run NEST on Windows |windows|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. important::

The following commands should work on Windows. Please note that NEST does not officially
support Windows!
Expand All @@ -161,8 +163,8 @@ In Powershell, '%cd%' might not work for the current directory. Then
you should explicitly specify a folder with existing write permissions.

In any case, this will download the docker image with the pre-installed
NEST master from https://hub.docker.com/r/nest/nest-simulator and start it.
After booting, a URL is presented. Click on it or copy it to your browser.
NEST master from https://hub.docker.com/r/nest/nest-simulator and start it.
After booting, a URL is presented. Click on it or copy it to your browser.
Voilá! Jupyter notebook starts from the docker image.

You can update the image with:
Expand Down
37 changes: 22 additions & 15 deletions doc/htmldoc/installation/user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,24 @@
User install instructions
=========================

Cross-platform |macos| |linux| |windows|
----------------------------------------
Cross-platform options
-----------------------

Docker
~~~~~~

Docker |linux| |macos| |windows|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:ref:`See our docker installation instructions <docker>`.

Conda install
~~~~~~~~~~~~~

Conda install |linux| |macos|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can install NEST with the :ref:`Conda forge package <conda_forge_install>`.

Live media
~~~~~~~~~~

Live media |linux| |macos| |windows|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We have live media (.ova) if you want to run NEST in a virtual machine.

Expand Down Expand Up @@ -128,20 +131,24 @@ macOS |macos|

brew install nest

--------


Options for Windows users |windows|
------------------------------------

Please note that NEST does not officially support Windows. Members of our community have had success
using NEST on Windows with the `Windows Subsystem for Linux <https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-11-with-gui-support#1-overview>`_.
You can also try our :ref:`docker container <docker_win>`.

.. |linux| image:: ../static/img/linux.png
:class: no-scaled-link
:scale: 11%
:scale: 7%

.. |macos| image:: ../static/img/macos.png
:class: no-scaled-link
:scale: 11%

:scale: 7%

.. |windows| image:: ../static/img/windows.png
:class: no-scaled-link
:scale: 11%



:scale: 7%