Skip to content

Commit 3e3daf8

Browse files
authored
Update README with image details and usage (#50)
1 parent 704ee44 commit 3e3daf8

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
# Pangeo Notebook Veda Image
22

3-
Docker container based on pangeo-notebook used on VEDA JupyterHub.
3+
Docker image based on pangeo-notebook used on VEDA JupyterHub.
4+
5+
## What's in the image
6+
7+
The image builds off a particular tagged version of the [pangeo-notebook image](https://github.com/pangeo-data/pangeo-docker-images/tree/master/pangeo-notebook). Which tag in particular is specified in [the first line of the Dockerfile](https://github.com/NASA-IMPACT/pangeo-notebook-veda-image/blob/main/Dockerfile#L1). You can figure out which packages are included in that version of pangeo-notebook image by checking the [environment.yml](https://github.com/pangeo-data/pangeo-docker-images/blob/master/pangeo-notebook/environment.yml) and the exact versions by checking [packages.txt](https://github.com/pangeo-data/pangeo-docker-images/blob/master/pangeo-notebook/packages.txt).
8+
9+
The image adds additional packages and environment variables specified in [environment.yml](environment.yml) without updating the existing libraries included in the default pangeo-notebook image.
10+
11+
## How to use the image
12+
13+
On each commit to this repository a new image is tagged and pushed to ECR. You can find the name of that image in the Github action that pushes it. The image name looks like:
14+
15+
- public.ecr.aws/nasa-veda/pangeo-notebook-veda-image:2025.08.14-v2 _for git tags_
16+
- public.ecr.aws/nasa-veda/pangeo-notebook-veda-image:d6df85b998c3 _for regular git commits_
17+
18+
That image name can be used on a JupyterHub that supports "Bring your own image". Just paste the image name into the "Custom image" input.
419

520
## Testing the image
621

0 commit comments

Comments
 (0)