aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2023-03-03 11:51:58 +0100
committerThomas White <taw@physics.org>2023-03-03 11:51:58 +0100
commit0f4e004e92545421a35980ead4279b38dbd8bdd7 (patch)
tree1669127c6bc876e04db3ad91b91c6cdffeecb11c
parent9604bffbb66b3d920ea677701e54ef032a36e572 (diff)
INSTALL.md: Mention containers
-rw-r--r--INSTALL.md26
-rw-r--r--README.md4
2 files changed, 28 insertions, 2 deletions
diff --git a/INSTALL.md b/INSTALL.md
index dc54b2f6..fd0954a1 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -23,6 +23,32 @@ and also to make sure that the installation is documented on the list of
supported facility installations.
+Installation via container registry
+-----------------------------------
+
+The easiest way to get started is to download our container image and run it
+using a virtualization tool of your choice (e.g. Docker, Podman,
+[Singularity/Apptainer](http://apptainer.org/)). For example, using Apptainer:
+```
+$ apptainer pull docker://gitlab.desy.de:5555/thomas.white/crystfel/crystfel:latest
+$ apptainer run -B /path/to/data crystfel_latest.sif
+```
+
+After the second command, you are working inside the container and should be
+able to run all the CrystFEL commands. Start by running ```crystfel``` to run
+the GUI.
+
+By default, only a few directories will be accessible inside the container,
+including your home directory. The argument ```--bind /path/to/data``` tells
+Apptainer to additionally make the given path available. You will probably need
+to use this to access your data.
+
+"Singularity" changed name to "Apptainer" in 2021. If you're using a slightly
+older version, simply replace ```apptainer``` with ```singularity``` in the
+commands above. Don't worry, it's the same software! Further documentation is
+available on [their website](http://apptainer.org/).
+
+
Installation via package manager
--------------------------------
diff --git a/README.md b/README.md
index 9a4760e8..dcfd81b6 100644
--- a/README.md
+++ b/README.md
@@ -14,8 +14,8 @@ Getting started
---------------
See [INSTALL.md](INSTALL.md) for installation instructions, including
-installation via package manager and details of pre-existing installations at
-X-ray facilities around the world.
+our container registry, installation via package manager and details of
+pre-existing installations at X-ray facilities around the world.
CrystFEL can be used from the command line or via a graphical user interface.
To start the graphical user interface, run ```crystfel```.