Skip to content

Commit

Permalink
Add v3.7 to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
steffengraber committed Apr 19, 2024
1 parent d01ede0 commit fa70bbb
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,15 @@ Currently the following docker images are provided
- nest/nest-simulator:3.4
- nest/nest-simulator:3.5
- nest/nest-simulator:3.6
- nest/nest-simulator:3.7

## Usage

You can use the docker images direct out of docker-registry.ebrains.eu like this:

docker pull nest/nest-simulator:TAG

TAG is '2.20.2', '3.2', '3.3', '3.4', '3.5', '3.6' or 'dev'.
TAG is '2.20.2', '3.2', '3.3', '3.4', '3.5', '3.6', '3.7' or 'dev'.

#### NEST 2.20.2

Expand All @@ -36,7 +37,7 @@ Jupyter lab with NEST 2.20.2
docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` -v $(pwd):/opt/data -e NEST_CONTAINER_MODE=jupyterlab \
-p 8080:8080 nest/nest-simulator:2.20.2

#### NEST 3.6
#### NEST 3.7

To use 'docker-compose' you need the definition file from the git repository. Download it:

Expand All @@ -49,7 +50,7 @@ To use 'docker-compose' you need the definition file from the git repository. Do
or

docker run -it --rm -e NEST_CONTAINER_MODE=nest-server -p 52425:52425 \
nest/nest-simulator:3.6
nest/nest-simulator:3.7

Starts the NEST API server container and opens the corresponding port 52425. Test it with `curl localhost:52425/api`.

Expand All @@ -60,9 +61,9 @@ To use 'docker-compose' you need the definition file from the git repository. Do
or

docker run -it --rm -e NEST_CONTAINER_MODE=nest-server -p 52425:52425 \
nest/nest-simulator:3.6
nest/nest-simulator:3.7
docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` -p 54286:54286 \
-e NEST_CONTAINER_MODE=nest-desktop nest/nest-simulator:3.6
-e NEST_CONTAINER_MODE=nest-desktop nest/nest-simulator:3.7

Starts the NEST server and the NEST desktop web interface. Port 54286 is also made available.
Open in the web browser: `http://localhost:54286`
Expand All @@ -74,9 +75,9 @@ To use 'docker-compose' you need the definition file from the git repository. Do
or

docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` -v $(pwd):/opt/data -e NEST_CONTAINER_MODE=notebook \
-p 8080:8080 nest/nest-simulator:3.6
-p 8080:8080 nest/nest-simulator:3.7

Starts a notebook server with pre-installed NEST 3.4. The corresponding URL is displayed in the console.
Starts a notebook server with pre-installed NEST 3.7. The corresponding URL is displayed in the console.

- Jupyter lab with NEST

Expand All @@ -85,9 +86,9 @@ To use 'docker-compose' you need the definition file from the git repository. Do
or

docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` -v $(pwd):/opt/data -e NEST_CONTAINER_MODE=jupyterlab \
-p 8080:8080 nest/nest-simulator:3.6
-p 8080:8080 nest/nest-simulator:3.7

Starts a jupyter lab server with pre-installed NEST 3.4. The corresponding URL is displayed in the console.
Starts a jupyter lab server with pre-installed NEST 3.7. The corresponding URL is displayed in the console.

To stop and delete running containers use `docker-compose down`.

Expand Down Expand Up @@ -128,7 +129,7 @@ You can clone this repository and use the shell script:
[<args>] can be either 'notebook', 'jupyterlab', or 'interactice'.
[<version>] kind of docker image (e.g. 'dev', '2.12.0', '2.14.0',
'2.16.0', '2.18.0', '3.0', '3.1', '3.2', '3.3', '3.4', '3.5',
'3.6' or 'all').
'3.6', '3.7' or 'all').

Example: sh run.sh provision dev
sh run.sh run notebook dev
Expand All @@ -137,7 +138,7 @@ You can clone this repository and use the shell script:

## 1 - 2 (- 3)

In the next steps, VERSION is the kind of docker image you want to use (3.2, dev, ...)
In the next steps, VERSION is the kind of docker image you want to use (3.7, dev, ...)

Two little steps to get started

Expand Down Expand Up @@ -190,7 +191,7 @@ In the folder with your music scripts run:

docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` \
-v $(pwd):/opt/data \
nest/nest-simulator:3.6 /bin/bash
nest/nest-simulator:3.7 /bin/bash

You are now on container's shell.

Expand Down

0 comments on commit fa70bbb

Please sign in to comment.