Summary

The nf-co2footprint plugin estimates the energy consumption and CO₂ footprint of Nextflow pipeline runs. It calculates energy usage for each task based on Nextflow resource metrics and compute system power consumption information, then uses carbon intensity data to estimate CO₂ emissions. The calculation methodology is based on the Green Algorithms Project. The plugin generates detailed TXT carbon footprint reports containing energy consumption, CO₂ emissions, and relevant metrics for each task, along with an HTML report showing pipeline-wide carbon footprint overview with visualizations of CO₂ emissions across different processes.

Get Started

Declare the plugin in your Nextflow pipeline configuration file:

plugins {
  id 'nf-co2footprint@1.4.1'
}

Run your pipeline with the usual command:

nextflow run .nf 

For more details, see the Nextflow plugin documentation and the configuration guide.

Examples

The plugin generates four output files:

• A detailed HTML report
• A text summary
• A trace file
• A provenance file

The plugin also provides a CLI command for post-run carbon footprint calculations from Nextflow's execution trace files, as well as a function that can be included in Nextflow pipelines. Additionally, the plugin provides recommendations on how to optimize the carbon footprint of runs.

License

Apache 2.0

Everything in this repository that is not covered by NOTICE is published under the Apache 2.0 license.