Skip to content

Commit 99aaa18

Browse files
authored
Revise README for version and package details
Updated README to reflect changes in versioning and package structure.
1 parent fa24e13 commit 99aaa18

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
[![Build and Push](https://github.com/nmfs-opensci/py-rocket-geospatial-2/actions/workflows/build-and-push.yml/badge.svg)](https://github.com/nmfs-opensci/py-rocket-geospatial-2/actions/workflows/build-and-push.yml)
44
[![ghcr.io](https://img.shields.io/badge/ghcr.io-container--images%2Fpy--rocket--geospatial--2-blue?logo=docker)](https://github.com/nmfs-opensci/container-images/pkgs/container/container-images%2Fpy-rocket-geospatial-2)
55

6-
**Latest version:** `2026.02.08`
7-
86
```bash
97
docker pull ghcr.io/nmfs-opensci/container-images/py-rocket-geospatial-2:latest
108
docker run -it --rm -p 8888:8888 ghcr.io/nmfs-opensci/container-images/py-rocket-geospatial-2:latest
@@ -16,17 +14,23 @@ TeXLive and Quarto are installed along with MyST and JupyterBook.
1614

1715
Python 3.11 is installed with a conda environment called notebook that is activated on opening the container. R 4.5.X is installed and operates separate from the conda notebook environment (conda is not on the PATH when using R). R can be used from RStudio or JupyterLab and the same R environment is used.
1816

19-
* [Python packages (source env files)](environment/env-core1.yml)
20-
* [R packages (source install file)](install.R)
21-
* [Pinned Python packages](packages-python-pinned.yaml) - Auto-generated list of all Python packages with pinned versions
22-
* [Pinned R packages](packages-r-pinned.R) - Auto-generated list of all R packages with pinned versions
23-
2417
## Structure
2518

26-
* The base infrastructure (Jupyter, Dask, Python install, conda env, R install, all the set ups around the user experience) are in [py-rocket-base](https://github.com/nmfs-opensci/py-rocket-base/). See the [py-rocket-base documentation](https://nmfs-opensci.github.io/py-rocket-base/) for information on the base image structure and design.
19+
* The base infrastructure (Jupyter, Dask, Python install, conda env, R install, all the set ups around the user experience) are in [py-rocket-base](https://github.com/nmfs-opensci/py-rocket-base/) which is the base image in the Dockerfile. See the [py-rocket-base documentation](https://nmfs-opensci.github.io/py-rocket-base/) for information on the base image structure and design.
2720
* py-rocket-geospatial-2 the Python scientific core packages and Python and R geospatial packages. Note the R core scientific packages are in py-rocket-base since rocker_verse is the base R.
2821
* py-rocket-geospatial-2 also installs QGIS, CoastWatch Utilities, and Panoply.
2922

23+
#### py-rocket-geospatial-2 files that determine the image packages
24+
* [Dockerfile](Dockerfile)
25+
* [Python packages (source env files)](environment)
26+
* [R packages (source install file)](install.R)
27+
* [system packages](apt.txt)
28+
29+
#### Package pins in the image
30+
* [Pinned Python packages](packages-python-pinned.yaml) - Auto-generated list of all Python packages with pinned versions
31+
* [Pinned R packages](packages-r-pinned.R) - Auto-generated list of all R packages with pinned versions
32+
33+
3034
## Customizing py-rocket-geospatial-2
3135

3236
* edit the Python packages here `environment/env-*.yml`

0 commit comments

Comments
 (0)