Summary

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

Get Started

Declare the plugin in your Nextflow pipeline configuration file:

plugins {
  id 'nf-co2footprint@1.4.0'
}

This is all that is needed. Run your pipeline with the usual command:

nextflow run .nf

More details are available in the Nextflow plugin documentation and the configuration guide.

Examples

The plugin generates multiple output files for analysis:

• Detailed HTML Report: An interactive HTML report with carbon footprint metrics and visualizations showing CO₂ emissions across different processes
• Text Summary: A human-readable text summary of the carbon footprint analysis
• Trace File: A detailed trace file with task-level carbon metrics
• Provenance File: A JSON file documenting the computation provenance

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 for integrated carbon tracking.

License

Apache 2.0

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