From 68dd515ffb1188973998311d70d73e832dba1265 Mon Sep 17 00:00:00 2001 From: Haris Zafeiropoulos Date: Wed, 26 Jul 2023 11:19:28 +0200 Subject: [PATCH] minor edits --- docs/faq.rst | 8 -------- docs/installation.rst | 9 +++++++++ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 7615a2c2..3440117e 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -29,16 +29,8 @@ metaGOflow supports both Docker (default) and Singularity container technologies By default, metaGOflow will use Docker; therefore, in this case Docker is a dependency for the workflow to run. However, in most HPC systems Singularity is preferred. -To enable Singularity, you need to add the `-s` argument when calling metaGOflow. -In case Singularity runs fail with an error message mentioning that a `.sif` file is missing, -you need to force-pull the images to be used from metaGOflow. -To make things easier, we have built the [get_singularity_images.sh](https://github.com/emo-bon/pipeline-v5/blob/develop/Installation/get_singularity_images.sh) to do so. -.. code-bloc:: bash - cd Installation - bash get_singularity_images.sh -Now, you are ready to run metaGOflow with Singularity! .. hint:: In case you are using Docker, it is strongly recommended to avoid installing it through `snap`. diff --git a/docs/installation.rst b/docs/installation.rst index 1029a815..66582bbf 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -56,4 +56,13 @@ In case ``conda`` is not already installed on your computing system, you may fol the instructions to get it `here `_. +In case Singularity runs fail with an error message mentioning that a `.sif` file is missing, +you need to force-pull the images to be used from metaGOflow. +To do so, you may run the ``get_singularity_images.sh`` [`url `_] script +that you shall find under the ``Installation`` folder. + +.. code-bloc:: bash + cd Installation + bash get_singularity_images.sh +