Skip to content

Commit

Permalink
tweaking README
Browse files Browse the repository at this point in the history
  • Loading branch information
vsoch committed Aug 10, 2018
1 parent 8590fac commit decc5f4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,27 +130,30 @@ If you would like to request a custom notebook, please [reach out](https://www.g


```bash
# To start a jupyter notebook in a specific directory
bash start.sh jupyter /path/to/dir
# To start a jupyter notebook in a specific directory ON the cluster resource
bash start.sh jupyter <cluster-dir>

# If you don't specify a path on the cluster, it defaults to your ${SCRATCH}
bash start.sh jupyter /scratch/users/<username>

# To start a jupyter notebook with tensorflow in a specific directory
bash start.sh py2-tensorflow /path/to/dir
bash start.sh py2-tensorflow <cluster-dir>

# If you want a GPU node, make sure your partition is set to "gpu."
# To start a jupyter notebook (via a Singularity container!) in a specific directory
bash start.sh singularity-jupyter /path/to/dir
bash start.sh singularity-jupyter <cluster-dir>
```

Want to create your own Singularity jupyter container? Use [repo2docker](https://www.github.com/jupyter/repo2docker) and then specify the container URI at the end:
Want to create your own Singularity jupyter container? Use [repo2docker](https://www.github.com/jupyter/repo2docker) and then specify the container URI at the end.

```bash
bash start.sh singularity.jupyter /path/to/dir <container>
bash start.sh singularity.jupyter <cluster-dir> <container>

# You can also run a general singularity container!
bash start.sh singularity /path/to/dir <container>
bash start.sh singularity <cluster-dir> <container>

# To start tensorboard in a specific directory (careful here and not recommended, as is not password protected)
bash start.sh start /path/to/dir
bash start.sh start <cluster-dir>

# To stop the running jupyter notebook server
bash end.sh jupyter
Expand Down
2 changes: 1 addition & 1 deletion sbatches/sherlock/py3-jupyter.sbatch
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

PORT=$1
NOTEBOOK_DIR=$2
NOTEBOOK_DIR=${2:-${SCRATCH}}
cd $NOTEBOOK_DIR

module load py-jupyter/1.0.0_py36
Expand Down
2 changes: 1 addition & 1 deletion start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ instruction_get_logs
echo
echo "== Instructions =="
echo "1. Password, output, and error printed to this terminal? Look at logs (see instruction above)"
echo "2. Browser: http://sh-02-21.int:56845/ -> http://localhost:56845/..."
echo "2. Browser: http://sh-02-21.int:$PORT/ -> http://localhost:$PORT/..."
echo "3. To end session: bash end.sh ${NAME}"

0 comments on commit decc5f4

Please sign in to comment.