Skip to content

Parameters

Customising parameters

You can adjust the nf-co2footprint plugin parameters in your config file as follows:

nextflow.config
def co2_timestamp = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss')

co2footprint {
    traceFile   = "${params.outdir}/co2footprint_trace_${co2_timestamp}.txt"
    reportFile  = "${params.outdir}/co2footprint_report_${co2_timestamp}.html"
    ci          = 300
    pue         = 1.4
}

Include the config file for your pipeline run using the -c Nextflow parameter, for example as follows:

nextflow run nextflow-io/hello -c nextflow.config

The following parameters are currently available:

  • traceFile: Name of the TXT carbon footprint report containing the energy consumption, the estimated CO2 emission and other relevant metrics for each task. Default: co2footprint_trace_<timestamp>.txt.
  • summaryFile: Name of the TXT carbon footprint summary file containing the total energy consumption and the total estimated CO2 emission of the pipeline run. Default: co2footprint_summary_<timestamp>.txt.
  • reportFile: Name of the HTML report containing information about the entire carbon footprint, overview plots and more detailed task-specific metrics. Default: co2footprint_report_<timestamp>.html.
  • ci: carbon intensity of the respective energy production. Mutually exclusive with the location parameter. Default: 475.
  • location: location code to automatically retrieve a location-specific CI value. For countries, these are ISO alpha-2 codes. For regions, it’s the ISO alpha-2 code for the country, followed by an identifier for the state, e.g. US-CA for “California, USA”. You can find the available data here. Mutually exclusive with the ci parameter. Default: null.
  • pue: power usage effectiveness, efficiency coefficient of the data centre. Default: 1.67.
  • powerdrawMem: power draw from memory. Default: 0.3725.
  • customCpuTdpFile: Input CSV file containing custom CPU TDP data. This should contain the following columns: model,TDP,n_cores,TDP_per_core. Note that this overwrites TDP values for already provided CPU models. You can find the by default used TDP data here. Default: null.
  • ignoreCpuModel: ignore the retrieved Nextflow trace cpu_model name and use the default CPU power draw value. This is useful, if the cpu model information provided by the linux kernel is not correct, for example, in the case of VMs emulating a different CPU architecture. Default: false.
  • powerdrawCpuDefault: the default value used as the power draw from a computing core. This is only applied if the parameter ignoreCpuModel is set or if the retrieved cpu_model could not be found in the given CPU TDP data. Default: 12.0.