Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
philiplinden committed Dec 27, 2023
1 parent 82945a1 commit f0fb5c6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
REGISTRY ?= ghcr.io/philiplinden
IMAGE ?= cremons-et-al-2022
TAG ?= test
TAG ?= main

build:
docker build . -t $(REGISTRY)/$(IMAGE):$(TAG)
Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,19 @@ from the data published by Cremons, et. al that accompanied their paper.

Reproduced figures and commentary are found in [repro/results.ipynb](repro/results.ipynb)
as a Jupyter Notebook running Python 3. Details about the code and environment
are found in [pyproject.toml](pyproject.toml)
are found in [pyproject.toml](pyproject.toml). The reproduction can be produced
using a docker image prepared from this repository.

```shell
# pull the image (bound to `make pull`)
docker pull ghcr.io/philiplinden/cremons-et-al-2022:main

# generate the plots (bound to `make run`)
docker run -v /home/phil/repos/philiplinden/cremons-et-al-2022:"/opt" ghcr.io/philiplinden/cremons-et-al-2022:main repro/main.py

# or run this on Bacalhau.org (bound to `make bacalhau`)
bacalhau docker run ghcr.io/philiplinden/cremons-et-al-2022:main repro/main.py
```

This work is licensed under a
[Creative Commons Attribution 4.0 International License][cc-by].
Expand Down

0 comments on commit f0fb5c6

Please sign in to comment.