Skip to content

Commit 6b001ca

Browse files
Merge pull request #3521 from jessica-mitchell/windows_install
Add Windows docker instructions for installation
2 parents 7cc22ce + 44e33c4 commit 6b001ca

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.. _windows_docker:
2+
3+
Install NEST on Windows with Docker
4+
===================================
5+
6+
7+
The NEST simulator does not officially support Windows, but there are several workarounds to make NEST work on this platform,
8+
including using Linux subsystems or Docker, the latter shown here.
9+
10+
This is a tried and tested solution with minimal preparation;
11+
the setup will take approximately 20 minutes and requires a system restart.
12+
13+
1. Download `Docker Desktop <https://www.docker.com/products/docker-desktop/>`_ for your Windows system and follow the instructions to install
14+
it.
15+
16+
You will have to create a user account and restart your system after installation.
17+
18+
2. Open Docker Desktop and in the search bar at the top type "NEST Simulator". You will find the most recent NEST build.
19+
20+
Select it and click "pull".
21+
(This will show up as nest/nest-simulator with a drop-down menu that should automatically show the most recent, stable build.)
22+
23+
3. You will have to run NEST Simulator with an internal server so you can use it with Python.
24+
25+
Open a Windows console (type "cmd" in the search bar and press enter), and copy and paste this command into the console:
26+
27+
``docker run -it -p 8888:8888 --name nest-jupyter nest/nest-simulator:3.8 /bin/bash``
28+
29+
(This is the command for version 3.8; change the version ID if neccessary)
30+
31+
Press enter and wait until the process is completed. You now have NEST running with an internal server.
32+
Keep the console open for the next step.
33+
34+
35+
4. NEST includes Jupyter for easy Python programming. To access this service, enter this command in the console:
36+
37+
``jupyter notebook --ip=0.0.0.0 --no-browser --allow-root"`` and press enter
38+
39+
You will receive a longer response that includes a line similar to this:
40+
::
41+
42+
(...)Or copy and paste one of these URLs:
43+
http://127.0.0.1:8888/?token=abc123...456
44+
45+
Copy the URL and paste it to your browser.
46+
47+
This should open Jupyter with NEST Simulator enabled.
48+
49+
5. After this initial setup, you can start NEST Simulator and jupyter-nest by
50+
51+
- running docker,
52+
- navigating to "containers"
53+
- clicking run on both "nest/nest_simulator:3.8" and "nest-jupyter"
54+
55+
.. note::
56+
57+
If the above steps to run NEST does not work, you can access it through the console
58+
59+
Enter: "docker start nest-jupyter" press enter
60+
Enter: "docker exec -it nest-jupyter bash" press enter, stay in this window and
61+
Enter: "jupyter notebook --ip=0.0.0.0 --no-browser --allow-root" press enter

0 commit comments

Comments
 (0)