Output

Files:

The nf-co2footprint plugin creates three output files:

• trace (sample)
  The trace file includes calculations for each task, similar to the Nextflow trace file. Within this file you can find resource usage details of specific tasks and also the hardware information of your CPU.

• summary (sample)
  The summary file includes the total CO₂ footprint of the workflow run and the configuration used for the plugin.

• report (sample)
  The HTML report contains information about the carbon footprint of the whole pipeline run as well as plots showing the distributions of the CO₂ emissions for the different processes. The CO₂ emissions are separated into newly generated (i.e. from non-cached tasks) and total (including cached tasks). Additionally, it contains a table with the metrics for all individual tasks. The table is limited to 10000 entries by default. It finishes up with an overview plot of the carbon intensities during the workflow execution.

• dataFile The data file contains all trace information in a tree structure with the levels in descending order session -> workflow -> process -> task. Example: A workflow consists of multiple processes / has multiple process level children. The total session emission estimation includes everything from the point of plugin start to stop in a similar manner to how Nextflow defines a TraceRecord, but through the Java-native OSHI library.

  Comparison session vs. workflow

  The tracking of resource usage, such as %cpu and memory differs slightly from the way Nextflow determines trace values. Therefore, it might not be 100% comparable. It is not guaranteed that workflow emissions are bigger than session emissions.

  Preliminary feature

  The data file is currently not in its final version. Changes in the near future are very likely.

Note

Column headers in tables displaying task-specific metrics use the same field names as Nextflow’s native trace output when representing the same metric. For field definitions, see the Nextflow documentation: Trace file fields.

Logging:

Log messages may indicate issues, successful steps, or warnings about potentially unwanted behavior. By default, identical messages triggered by multiple tasks are shown only once in the console, while every occurrence is recorded in the .nextflow.log file with a [DUPLICATE] tag.