README.md

nf-co2footprint plugin [WIP]

A Nextflow plugin to estimate the CO₂ footprint of pipeline runs.

📚 Docs 👉🏻 https://nextflow-io.github.io/nf-co2footprint

Introduction

The nf-co2footprint plugin estimates the energy consumption for each pipeline task based on the Nextflow resource usage metrics and information about the power consumption of the underlying compute system. The carbon intensity of the energy production is then used to estimate the respective CO₂ emission.

The calculation is based on the carbon footprint computation method developed in the Green Algorithms project: www.green-algorithms.org

Green Algorithms: Quantifying the Carbon Footprint of Computation.

Lannelongue, L., Grealey, J., Inouye, M.,

Adv. Sci. 2021, 2100707. https://doi.org/10.1002/advs.202100707

The nf-co2footprint plugin generates a detailed TXT carbon footprint report containing the energy consumption, the estimated CO₂ emission and other relevant metrics for each task. Additionally, an HTML report is generated with information about the carbon footprint of the whole pipeline run and containing plots showing, for instance, an overview of the CO₂ emissions for the different processes.

Quick Start

Declare the plugin in your Nextflow pipeline configuration file:

plugins {
  id '[email protected]'
}

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

You can find more information on plugins in the Nextflow documentation.

Note

To test the plugin prior to its first release, refer to the contributing documentation.

Credits

The nf-co2footprint plugin is mainly developed and maintained by Sabrina Krakau and Júlia Mir-Pedrol at QBiC.

We thank the following people for their extensive assistance in the development of this pipeline:

• Phil Ewels
• Paolo Di Tommaso