Note singularity container in README

mmore500 · Jan 8, 2025 · b5b8c91 · b5b8c91
1 parent e85acde
commit b5b8c91
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,12 @@ _hstrat_ enables phylogenetic inference on distributed digital evolution populat
 
 `python3 -m pip install hstrat`
 
+A containerized release of `hstrat` is available via <ghcr.io>
+
+```bash
+singularity exec docker://ghcr.io/mmore500/hstrat:v1.17.2 python3 -m hstrat --help
+```
+
 ## Features
 
 _hstrat_ serves to enable **robust, efficient extraction of evolutionary history** from evolutionary simulations where centralized, direct phylogenetic tracking is not feasible.

diff --git a/setup.cfg b/setup.cfg
@@ -13,6 +13,8 @@ CITATION.cff =
   version: {pep440_version}
 pyproject.toml =
   version = "{pep440_version}"
+README.md =
+  singularity exec docker://ghcr.io/mmore500/hstrat:v{pep440_version} python3 -m hstrat --help
 
 [bdist_wheel]
 universal = 1