Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 2.58 KB

scw.md

File metadata and controls

64 lines (46 loc) · 2.58 KB

nf-core/configs: Super Computing Wales configuration

A base configuration file for running nf-core pipelines has been set up for use with Super Computing Wales (SCW). To use this profile, the pipeline can be run with the option -profile scw, which will download the scw.config config file. This config file by default runs pipelines using Singularity, and runs all jobs on the htc partition.

To run an nf-core pipeline, you will first need to activate Nextflow. You can do this with the following command:

module load nextflow
## you might want to load a specific nextflow version for reproducibility - find them under /apps/modules/tools
module avail
module load nextflow/21.10.6

Downloading Singularity containers

By default, Nextflow will download Singularity containers to a cache directory within the pipeline directory. To reduce storage space and to reuse containers between pipelines, you should set the environment variable NXF_SINGULARITY_CACHEDIR to somewhere on the /scratch partition in your ~/.bashrc file:

echo NXF_SINGULARITY_CACHEDIR=/scratch/username/singularity-containers >> ~/.bashrc

## Downloading pipelines for offline use

To download an nf-core pipeline for offline use, you will have to install the nf-core tool in a conda environment:

module load mambaforge/4.10.1
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
conda config --set channel_priority strict
conda create -n nf-core
conda activate nf-core
conda install -c bioconda nf-core

Then you can download the pipeline of your choice to run:

nf-core download pipeline_name

And run it with the following:

nextflow run /path/to/download/nf-core-pipeline/workflow/ -profile scw

More detailed instructions are available on the nf-core website.

Configuring modules to use different partitions

SCW provides a number of different partitions for different use cases. By default this config file uses HTC, but it is simple to change this for specific modules. Simply create a new config file, and specify a new queue for each module you wish to change. For example, to run SPADEs on the highmem partition in the nf-core/mag pipeline, create a config file (e.g. pipeline_options.config) with the following:

process {
  withName: SPADES {
    cpus = 40
    memory = 360.GB
    queue = "highmem"
  }

And specify this config when running the pipeline with -c pipeline_options.config