nf-core/configs: CFC Configuration

All nf-core pipelines have been successfully configured for use on the CFC cluster at the Quantitative Biology Center here.

This profile is designed for developmental work, where container images might be frequently updated.

To use, run the pipeline with -profile cfc_dev. This will download and launch the cfc_dev.config which has been pre-configured with a setup suitable for the CFC cluster. Using this profile, for DSL1 pipelines a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. For pipelines in DSL2, the individual Singularity images will be downloaded.

Before running the pipeline you will need to install Nextflow on the CFC cluster. You can do this by following the instructions here.

This config includes the cluster-specific parameters for estimating the CO2 footprint via the nf-co2footprint plugin of any pipeline run on the cluster. The parameters include the cluster-specific power usage effectiveness (PUE) and the location of the cluster in Germany(DE).

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.

Config file

See config file on GitHub

conf/cfc_dev
//Profile config names for nf-core/configs
params {
    config_profile_description = 'QBiC Core Facility cluster dev profile without container cache provided by nf-core/configs.'
    config_profile_contact     = 'Sabrina Krakau (@skrakau)'
    config_profile_url         = 'http://qbic.uni-tuebingen.de/'
}
 
singularity {
    enabled = true
}
 
process {
    resourceLimits = [
        memory: 1992.GB,
        cpus: 128,
        time: 168.h
    ]
    executor = 'slurm'
    queue    = 'qbic'
    scratch  = 'true'
}
 
params {
    igenomes_base = '/nfsmounts/igenomes'
    max_memory    = 1992.GB
    max_cpus      = 128
    max_time      = 168.h
}
 
/*
 * By default the nf-co2footprint plugin is not activated. To activate it, please add
 * ````
 * plugins {
 *  id 'nf-co2footprint@<VERSION>'
 * }
 * ```
 * in your config, or use the
 * `-plugins nf-co2footprint@<VERSION>` parameter in your nextflow call.
 */
co2footprint {
    String co2Timestamp = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss')
 
    // Determine timestamp suffix
    String timestampSuffix = params.get('trace_report_suffix') ?: (this.hasProperty('trace_timestamp') ? this.trace_timestamp : co2Timestamp)
 
    // File parameters
    if (params.containsKey('outdir')) {
        String infoDir = "${params.outdir}/pipeline_info"
        traceFile   = "${infoDir}/co2footprint_trace_${timestampSuffix}.txt"
        reportFile  = "${infoDir}/co2footprint_report_${timestampSuffix}.html"
        summaryFile = "${infoDir}/co2footprint_summary_${timestampSuffix}.txt"
    }
 
    // Standard parameters
    location = 'DE'
    pue = 1.3
}