From 920947e7a35da1c5792ca0e3beb29b5cf91e9752 Mon Sep 17 00:00:00 2001 From: Steffen Graber Date: Wed, 6 Dec 2023 10:34:44 +0100 Subject: [PATCH] Add v3.6 to documentation and run script (#211) * Add 3.6 to documentation * Add 3.6 to run script --- README.md | 37 ++++++++++++++++++++----------------- run.sh | 19 +++++++++++-------- 2 files changed, 31 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index d45bc28..b87c473 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,15 @@ If you know how to use docker, you know how to use NEST. Currently the following docker images are provided - - nest/nest-simulator:dev (~2,26GB) - - nest/nest-simulator:2.20.2 (~634MB) - - nest/nest-simulator:3.0 (~1,07GB) - - nest/nest-simulator:3.1 (~1,34GB) - - nest/nest-simulator:3.2 (~1,9GB) - - nest/nest-simulator:3.3 (~1,9GB) - - nest/nest-simulator:3.4 (~2,27GB) + - nest/nest-simulator:dev + - nest/nest-simulator:2.20.2 + - nest/nest-simulator:3.0 + - nest/nest-simulator:3.1 + - nest/nest-simulator:3.2 + - nest/nest-simulator:3.3 + - nest/nest-simulator:3.4 + - nest/nest-simulator:3.5 + - nest/nest-simulator:3.6 ## Usage @@ -20,7 +22,7 @@ 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' or 'dev'. +TAG is '2.20.2', '3.2', '3.3', '3.4', '3.5', '3.6' or 'dev'. #### NEST 2.20.2 @@ -34,7 +36,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.4 +#### NEST 3.6 To use 'docker-compose' you need the definition file from the git repository. Download it: @@ -47,7 +49,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.4 + nest/nest-simulator:3.6 Starts the NEST API server container and opens the corresponding port 52425. Test it with `curl localhost:52425/api`. @@ -58,9 +60,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.4 + nest/nest-simulator:3.6 docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` -p 54286:54286 \ - -e NEST_CONTAINER_MODE=nest-desktop nest/nest-simulator:3.4 + -e NEST_CONTAINER_MODE=nest-desktop nest/nest-simulator:3.6 Starts the NEST server and the NEST desktop web interface. Port 54286 is also made available. Open in the web browser: `http://localhost:54286` @@ -72,7 +74,7 @@ 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.4 + -p 8080:8080 nest/nest-simulator:3.6 Starts a notebook server with pre-installed NEST 3.4. The corresponding URL is displayed in the console. @@ -83,7 +85,7 @@ 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.4 + -p 8080:8080 nest/nest-simulator:3.6 Starts a jupyter lab server with pre-installed NEST 3.4. The corresponding URL is displayed in the console. @@ -125,7 +127,8 @@ You can clone this repository and use the shell script: can be either 'provision', 'run' or 'clean'. [] can be either 'notebook', 'jupyterlab', or 'interactice'. [] 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' or 'all'). + '2.16.0', '2.18.0', '3.0', '3.1', '3.2', '3.3', '3.4', '3.5', + '3.6' or 'all'). Example: sh run.sh provision dev sh run.sh run notebook dev @@ -187,7 +190,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.4 /bin/bash + nest/nest-simulator:3.6 /bin/bash You are now on container's shell. @@ -202,7 +205,7 @@ You are now on container's shell. - Export a docker image - docker save nest/nest-simulator:3.4 | gzip -c > nest-docker.tar.gz + docker save nest/nest-simulator:3.5 | gzip -c > nest-docker.tar.gz - Import a docker image diff --git a/run.sh b/run.sh index 8ded23e..d36f0dd 100755 --- a/run.sh +++ b/run.sh @@ -50,11 +50,11 @@ case $command in echo echo "Provisioning needs an argument: 'dev' 'latest_daint' '2.12.0', '2.14.0', '2.14.2'," - echo "'2.16.0', '2.18.0', '2.20.0', '2.20.1', '2.20.2', '3.0','3.1', '3.2', '3.3', '3.4' 'all' or 'base'." + echo "'2.16.0', '2.18.0', '2.20.0', '2.20.1', '2.20.2', '3.0','3.1', '3.2', '3.3', '3.4', '3.5', '3.6','all' or 'base'." echo while test $# -gt 0; do case "$1" in - dev | latest_daint | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4) + dev | latest_daint | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 | 3.5 | 3.6) echo "Build the NEST image for NEST $1" echo docker build -t nest/nest-simulator:"$1" ./src/"$1" @@ -72,7 +72,8 @@ case $command in all) echo "Build the NEST image for NEST 2.12.0, 2.14.0, 2.14.2" - echo "2.16.0, 2.18.0, 2.20.0, 2.20.1, 2.20.2, 3.0, 3.1, 3.2, 3.3, 3.4, dev and latest_daint" + echo "2.16.0, 2.18.0, 2.20.0, 2.20.1, 2.20.2, 3.0, 3.1, 3.2," + echo "3.3, 3.4, 3.5, 3.6, dev and latest_daint" echo docker build -t nest/nest-simulator:2.12.0 ./src/2.12.0 docker build -t nest/nest-simulator:2.14.0 ./src/2.14.0 @@ -87,6 +88,8 @@ case $command in docker build -t nest/nest-simulator:3.2 ./src/3.2 docker build -t nest/nest-simulator:3.3 ./src/3.3 docker build -t nest/nest-simulator:3.4 ./src/3.4 + docker build -t nest/nest-simulator:3.4 ./src/3.5 + docker build -t nest/nest-simulator:3.4 ./src/3.6 docker build -t nest/nest-simulator:dev ./src/dev docker build -t nest/nest-simulator:latest_daint ./src/latest_daint echo @@ -109,14 +112,15 @@ case $command in echo " - 'interactive VERSION'" echo echo "VERSION is the version of NEST" - echo "(e.g. dev, 2.12.0, 2.14.0, 2.14.2, 2.16.0, 2.18.0, 2.20.0, 2.20.1, 2.20.2, 3.0, 3.1, 3.2, 3.3, 3.4)" + echo "(e.g. dev, 2.12.0, 2.14.0, 2.14.2, 2.16.0, 2.18.0, 2.20.0," + echo "2.20.1, 2.20.2, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6)" echo LOCALDIR="$(pwd)" while test $# -gt 1; do case "$1" in notebook) case "$2" in - dev | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 ) + dev | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 | 3.5 | 3.6 ) echo "Run NEST-$2 with Jupyter Notebook". echo docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` --name my_app \ @@ -132,8 +136,7 @@ case $command in ;; jupyterlab) case "$2" in - dev | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 ) - echo "Run NEST-$2 with Jupyter Lab". + dev | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 | 3.5 | 3.6 ) echo docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` --name my_app \ -v $(pwd):/opt/data -e NEST_CONTAINER_MODE=jupyterlab \ @@ -148,7 +151,7 @@ case $command in ;; interactive) case "$2" in - dev | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 ) + dev | 2.12.0 | 2.14.0 | 2.14.2 | 2.16.0 | 2.18.0 | 2.20.0 | 2.20.1 | 2.20.2 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 | 3.5 | 3.6 ) echo "Run NEST-$2 in interactive mode." echo docker run -it --rm -e LOCAL_USER_ID=`id -u $USER` --name my_app -e NEST_CONTAINER_MODE=interactive \