Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xingyzt committed Apr 3, 2024
1 parent 582e9f5 commit 3b3b1dc
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
### Docker image for analyzing AWS S3-hosted DESI data with Jupyterlab

ARG DESI_RELEASE=edr

# Build from container provided by Jupyter
# ========================================
# https://github.com/jupyter/docker-stacks
Expand All @@ -15,6 +13,8 @@ FROM quay.io/jupyter/$STACK_BASE:$STACK_VERSION
# Set-up environment
# ==================

ENV DESI_RELEASE=edr

# Slight customization to Bash
# https://docs.docker.com/develop/develop-images/instructions/#using-pipes
# This fails commands even if errors occur before a pipe
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ sudo systemctl start docker.service
we recommend installing [Docker engine](https://docs.docker.com/engine/install/) (the command-line tool).
Otherwise, you should install [Docker Desktop](https://docs.docker.com/get-docker/).

3. Run this line to run the image.
2. Run this line to run the image.
```bash
docker run -it -p 8888:8888 \
--volume "$(pwd):/mnt/local_volume" \
Expand All @@ -121,3 +121,10 @@ This is not ideal for security, so if that is a major concern, then we do recomm

3. Locate the line beginning with `http://127.0.0.1:8888/lab?token=...` in the output, and open the address in your browser.
(If you are running a cloud instance, replace `127.0.0.1` with the public IP address of your cloud server.)

### Updating the Docker image

To update your Docker image, run
```bash
docker pull ghcr.io/flyorboom/docker-aws-jupyter:main
```
6 changes: 4 additions & 2 deletions welcome.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"# Welcome!\n",
"\n",
"* This is the home directory **~** (`$HOME`) of this Docker container.\n",
"* DESI data releases are mounted at **~/desibucket**. EDR, the latest public release, is at **~/desibucket/edr** (`$DESI_ROOT`). \n",
"* Public DESI data releases are mounted at **~/desibucket**.\n",
"* EDR, the latest public release, is found in **~/desibucket/edr** (`$DESI_ROOT`).\n",
"* Example code for analyzing the data can be found at **~/tutorials**.\n",
"* Pipeline code for processing the data are installed at **~/desihub**.\n",
"* For convenience, files inside **~/synced** (`$SYNCED`) are synced to the directory in which you ran this container.\n",
Expand Down Expand Up @@ -38,7 +39,8 @@
"`$DESI_ROOT` is the [environment variable](https://en.wikipedia.org/wiki/Environment_variable)\n",
"holding the path to the latest public DESI data release. \n",
"Some code in the tutorials directly refer to the path in the NERSC servers instead.\n",
"You will have to replace those instances of **/global/cfs/cdirs/desi/public/<release>** with `os.environ[\"DESI_ROOT\"]`."
"You will have to replace those instances of **/global/cfs/cdirs/desi/public/\\<release\\>/\\<stuff\\>** ",
"with `os.path.expandvars(\"$DESI_ROOT/<stuff>\")`."
]
},
{
Expand Down

0 comments on commit 3b3b1dc

Please sign in to comment.