Skip to content
Snippets Groups Projects
Commit 25e11125 authored by alex's avatar alex
Browse files

Add information to use the Singularity cache for LINC

parent c5fd506e
No related branches found
No related tags found
1 merge request!128Add information to use the Singularity cache for LINC
Pipeline #35363 failed
...@@ -45,7 +45,7 @@ Once you have installed `cwltool`_ or `toil`_ locally on your system, LINC will ...@@ -45,7 +45,7 @@ Once you have installed `cwltool`_ or `toil`_ locally on your system, LINC will
You will find more details how to run **LINC** within an image on the page :doc:`how to run the pipeline<running>`. You will find more details how to run **LINC** within an image on the page :doc:`how to run the pipeline<running>`.
Manual installation Manual installation
-------------------------- -------------------
.. note:: .. note::
Skip this section if you want to run **LINC** using software containers. Skip this section if you want to run **LINC** using software containers.
......
...@@ -173,6 +173,25 @@ You can restart a pipeline if using ``toil`` through adding the parameter ``--re ...@@ -173,6 +173,25 @@ You can restart a pipeline if using ``toil`` through adding the parameter ``--re
``toil``'s ``--restart`` option is only useful if a temporary error has occured, since it will always reuse the workflow and the data it originally has started with. If those needed to be changed (software update/corrupted or missing data), you will have to delete the ``jobStore`` and start a fresh run. ``toil``'s ``--restart`` option is only useful if a temporary error has occured, since it will always reuse the workflow and the data it originally has started with. If those needed to be changed (software update/corrupted or missing data), you will have to delete the ``jobStore`` and start a fresh run.
Running **LINC** with a cached Singularity image
------------------------------------------------
Typical reasons for which you would like to run **LINC** with a cached Singularity image:
* when running into a Docker pull limit.
* when compute nodes do not have an outbound connection to the internet or any similar firewall restrictions.
In such cases you need to set a special CWL environment variable to make use of it:
$ export CWL_SINGULARITY_CACHE=<cachedir>
$ export SINGULARITY_TMPDIR=<cachedir>/tmp
where ``<cachedir>`` is your chosen location of the Singularity image. When running **LINC**, the location of the ``<cachedir>`` should be visible from all compute nodes or machines you want to use. Once set simply restart your pipeline with ``--singularity`` and the image should be put into the right directory and be used for all steps.
Setting ``$SINGULARITY_TMPDIR`` is optional and avoids temporary mounting of the images in your ``/tmp``-directory. This is particularly helpful if your ``/tmp``-directory does not have much disk space.
If you need to update your **LINC** Singularity image, simply remove the ``astronrd_linc.sif`` file in your ``<cachedir>`` and clean the Singularity cache:
$ singularity cache clean
Troubleshooting Troubleshooting
--------------- ---------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment