Giter Site home page Giter Site logo

nf-co2footprint's Introduction

nf-co2footprint plugin [WIP]

A Nextflow plugin to estimate the CO2 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 CO2 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 CO2 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 CO2 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:

nf-co2footprint's People

Contributors

skrakau avatar mirpedrol avatar pditommaso avatar mashehu avatar jorgeaguileraseqera avatar bentsherman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.