Skip to content
Snippets Groups Projects

RAP-840 Add Read the Docs

Merged Mick Veldhuis requested to merge rap-840-add-docs into main
Compare and Show latest version
1 file
+ 1
1
Compare changes
  • Side-by-side
  • Inline
@@ -46,6 +46,6 @@ To run the pipeline within a Docker container, please build the image located in
$ docker build ../.. -f Dockerfile -t preprocess:latest
Please modify 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.
Please modify 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.
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