Merge pull request #14 from Imageomics/7-improve-docs

Add docker/singularity instructions to README

Author: johnbradley

README.md

@@ -65,3 +65,29 @@ Download files from the published dataset with DOI doi:10.5072/FK2/B7LCCX in htt
 ```
 dva download doi:10.5072/FK2/B7LCCX data --url https://datacommons.tdai.osu.edu/
 ```
+
+## Docker and Singularity Support
+A Docker image is built for each release of `dataverse-access` that can be used with both [Docker](https://www.docker.com/) and [Singularity/Apptainer](https://apptainer.org/). The images are available at [ghcr.io/imageomics/dataverse-access](https://github.com/Imageomics/dataverse-access/pkgs/container/dataverse-access). The images are tagged with the version of each release.
+
+### Docker Download Example
+The following example downloads files into a `data` subdirectory of the current working directory:
+```
+docker run \
+    -v $(pwd)/data:/data \
+    -it ghcr.io/imageomics/dataverse-access \
+    dva download doi:10.5072/FK2/B7LCCX /data --url https://datacommons.tdai.osu.edu/
+```
+To persist downloaded files when using Docker typically requires mounting a volume.
+The above example uses the [-v docker argument](https://docs.docker.com/storage/volumes/#choose-the--v-or---mount-flag) to mount a `data` subdirectory within the current working directory as `/data` in the container.
+
+### Singularity/Apptainer Download Example
+The following example downloads files into a `data` subdirectory of the current working directory:
+```
+singularity run docker://ghcr.io/imageomics/dataverse-access \
+     dva download doi:10.5072/FK2/B7LCCX data --url https://datacommons.tdai.osu.edu/
+```
+Since singularity typically will mount the current working directory the above command does not mount any extra directories.
+For help on mounting directories with the singularity command see the [singularity path binding documentation](https://apptainer.org/docs/user/main/bind_paths_and_mounts.html#user-defined-bind-paths).
+
+## Versioning
+Releases of dataverse-access follow [Semantic Versioning](https://semver.org/).  Semantic versioning only applies to the `dva` command line interface and not the underlying python code.