Skip to content
Snippets Groups Projects

RAP-840 Add Read the Docs

Merged Mick Veldhuis requested to merge rap-840-add-docs into main
1 file
+ 8
2
Compare changes
  • Side-by-side
  • Inline
@@ -40,6 +40,12 @@ Please follow their respective installation instructions.
Docker Installation
-------------------
The dependencies are also available as a Docker image, which the Pre-Processing Pipeline will attempt to retrieve from DockerHub. This requires one to install Docker on their system, either `Docker Engine <https://docs.docker.com/engine/>`_ (only available for Linux) or `Docker Desktop <https://docs.docker.com/desktop/>`_ (available for Windows, MacOS, and Linux).
To run the pipeline within a Docker container, please build the image located in the ``docker/pipeline`` directory of the repository:
Instead of Docker, one could also use `Apptainer <https://apptainer.org/>`_ (previously called Singularity) on Linux. Refer to :doc:`running` if you want to use this feature when running the pipeline.
.. code:: console
$ docker build ../.. -f Dockerfile -t <tag>
And give the image an appropriate tag with the ``-t`` option. This requires one to install Docker on their system, either `Docker Engine <https://docs.docker.com/engine/>`_ (only available for Linux) or `Docker Desktop <https://docs.docker.com/desktop/>`_ (available for Windows, MacOS, and Linux). Instead of Docker, one could also use `Apptainer <https://apptainer.org/>`_ (previously called Singularity) on Linux. Refer to :doc:`running` if you want to use this feature when running the pipeline.
Note: if the dependencies have not been installed manually and the pipeline is not ran inside a container, workflow components will attempt to run inside a Docker or Docker-compatible container environment. In this case, a Docker container is pulled from the repository's container registry.
Loading