Commit c2b0ce36 authored by sfux's avatar sfux
Browse files

Update README.md

parent 1ed0bdbe
......@@ -79,13 +79,17 @@ https://scicomp.ethz.ch/wiki/Setting_permanent_default_for_software_stack_upon_l
The start_jupyer_nb.sh script needs to be executed on your local computer. Please find below the list of options that can be used with the script:
```
$ ./start_jupyter_nb.sh -h
$ ./start_jupyter_nb.sh --help
./start_jupyter_nb.sh: Script to start jupyter notebook/lab on Euler from a local computer
Usage: start_jupyter_nb.sh [options]
Required options:
Options:
-u | --username USERNAME ETH username for SSH connection to Euler
-n | --numcores NUM_CPU Number of CPU cores to be used on the cluster
-W | --runtime RUN_TIME Run time limit for jupyter notebook/lab in hours and minutes HH:MM
-m | --memory MEM_PER_CORE Memory limit in MB per core
Optional arguments:
......@@ -96,12 +100,9 @@ Optional arguments:
-i | --interval INTERVAL Time interval for checking if the job on the cluster already started
-k | --key SSH_KEY_PATH Path to SSH key with non-standard name
-l | --lab Start jupyter lab instead of a jupyter notebook
-m | --memory MEM_PER_CORE Memory limit in MB per core
-n | --numcores NUM_CPU Number of CPU cores to be used on the cluster
-s | --softwarestack SOFTWARE_STACK Software stack to be used (old, new)
-v | --version Display version of the script and exit
-w | --workdir WORKING_DIR Working directory for the jupyter notebook/lab
-W | --runtime RUN_TIME Run time limit for jupyter notebook/lab in hours and minutes HH:MM
Examlples:
......@@ -109,7 +110,7 @@ Examlples:
./start_jupyter_nb.sh --username sfux --numcores 2 --runtime 01:30 --memory 2048 --softwarestack new
./start_jupyter_nb.sh -c $HOME/.jnb_config
./start_jupyter_nb.sh -c /c/Users/sfux/.jnb_config
Format of configuration file:
......@@ -124,6 +125,9 @@ JNB_SOFTWARE_STACK="new" # Software stack to be used (old, new)
JNB_WORKING_DIR="" # Working directory for jupyter notebook/lab
JNB_ENV="" # Path to virtual environment
JNB_JLAB="" # "lab" -> start jupyter lab; "" -> start jupyter notebook
```
### Reconnect to a Jupyter notebook
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment