nf-configs/docs/cfc.md

# nf-core/configs: CFC Configuration

All nf-core pipelines have been successfully configured for use on the CFC cluster at the insert institution here.

To use, run the pipeline with `-profile cfc`. This will download and launch the [`cfc.config`](../conf/cfc.config) which has been pre-configured with a setup suitable for the CFC cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline.

Before running the pipeline you will need to load Nextflow and Singularity using the environment module system on CFC cluster. You can do this by issuing the commands below:

```bash
## Load Nextflow and Singularity environment modules
module purge
module load devel/java_jdk/1.8.0u121
module load devel/singularity/3.4.2
```

> NB: You will need an account to use the HPC cluster CFC in order to run the pipeline. If in doubt contact IT.
> NB: Nextflow will need to submit the jobs via the job scheduler to the HPC cluster and as such the commands above will have to be executed on one of the login nodes. If in doubt contact IT.

The queues are set to be `qbic` or `compute` and will be chosen automatically for you depending on your job submission.