From 4ad6bb2bec13d3bf7d4d256c6e2f23e789e5c92d Mon Sep 17 00:00:00 2001 From: ameynert Date: Wed, 17 Mar 2021 14:50:40 +0000 Subject: [PATCH] Singularity info --- docs/eddie.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/eddie.md b/docs/eddie.md index e6a2f87..fec6539 100644 --- a/docs/eddie.md +++ b/docs/eddie.md @@ -11,10 +11,10 @@ There is a Slack channel dedicated to eddie users on the MRC IGMM Slack: [https: To use, run the pipeline with `-profile eddie` (one hyphen). This will download and launch the [`eddie.config`](../conf/eddie.config) which has been pre-configured with a setup suitable for the [University of Edinburgh Eddie HPC](https://www.ed.ac.uk/information-services/research-support/research-computing/ecdf/high-performance-computing). -The configuration file supports running nf-core pipelines with either a Conda environment or Docker containers running under Singularity. +The configuration file supports running nf-core pipelines with Docker containers running under Singularity. Support for Conda will follow. ```bash -nextflow run nf-core/PIPELINE -profile eddie # ..rest of pipeline flags +nextflow run nf-core/PIPELINE -profile eddie,singularity # ..rest of pipeline flags ``` Before running the pipeline you will need to install Nextflow or load it from the module system. Generally the most recent version will be the one you want. @@ -30,11 +30,19 @@ To load the most recent version: module load igmm/apps/nextflow ``` - This config enables Nextflow to manage the pipeline jobs via the SGE job scheduler and using Conda or Singularity for software management. To set up Nextflow on a login node ... TODO +## Singularity set-up + +Load Singularity from the module system and set the Singularity cache directory to the NextGenResources path for the pipeline and version you want to run. If this does not exist, please contact the [IGMM Data Manager](data.manager@igmm.ed.ac.uk) to have it added. + +``` +module load singularity +export NXF_SINGULARITY_CACHEDIR="/exports/igmm/eddie/NextGenResources/nextflow/singularity/nf-core-rnaseq_v3.0" +``` + ## Using iGenomes references A local copy of the iGenomes resource has been made available on the Eddie HPC so you should be able to run the pipeline against any reference available in the `igenomes.config`.