From f7e8942d69541f8a712d691025cab94b6573b035 Mon Sep 17 00:00:00 2001 From: Till Englert Date: Thu, 12 Dec 2024 11:11:10 +0100 Subject: [PATCH 01/10] Fix numbering in contribute Signed-off-by: Till Englert --- docs/contributing/setup.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/contributing/setup.md b/docs/contributing/setup.md index 53f15f9..7d17a7b 100644 --- a/docs/contributing/setup.md +++ b/docs/contributing/setup.md @@ -15,19 +15,16 @@ To test with Nextflow for development purpose: cd .. && git clone https://github.com/nextflow-io/nextflow cd nextflow && ./gradlew exportClasspath ``` - 2. Append the following line to the `settings.gradle` in this project: ```bash includeBuild('../nextflow') ``` - 3. Compile the plugin code ```bash ./gradlew compileGroovy ``` - 4. Run nextflow with this command: ```bash From 3c973fb2cdd2b60aafc3f2dd567a6d2f0a49718e Mon Sep 17 00:00:00 2001 From: Till Englert Date: Thu, 12 Dec 2024 11:12:04 +0100 Subject: [PATCH 02/10] fix broken links Signed-off-by: Till Englert --- docs/co2footprint.md | 2 +- docs/contributing/setup.md | 3 +-- docs/usage/parameters.md | 4 ++-- mkdocs.yml | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/co2footprint.md b/docs/co2footprint.md index 9fb7a00..c2eacef 100644 --- a/docs/co2footprint.md +++ b/docs/co2footprint.md @@ -35,7 +35,7 @@ This includes failed tasks as well. ## Used data -If the `location` parameter is specified, the plugin makes use of [location-specific CI data](../../plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv) that was copied from the Green Algorithms project [green-algorithms-tool/data](https://github.com/GreenAlgorithms/green-algorithms-tool/tree/master/data). +If the `location` parameter is specified, the plugin makes use of [location-specific CI data](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv) that was copied from the Green Algorithms project [green-algorithms-tool/data](https://github.com/GreenAlgorithms/green-algorithms-tool/tree/master/data). The CPU TDP data from the Green Algorithms project is used to retrieve model-specific CPU power draw values. diff --git a/docs/contributing/setup.md b/docs/contributing/setup.md index 7d17a7b..9710306 100644 --- a/docs/contributing/setup.md +++ b/docs/contributing/setup.md @@ -46,7 +46,6 @@ The plugin can be tested without using a local Nextflow build using the followin ./gradlew compileGroovy make install ``` - 2. Run nextflow with this command, specifying the plugin version: ```bash @@ -65,7 +64,7 @@ To compile and run the tests use the following command: ## Change and preview the docs -The docs are generated using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To change the docs, edit the files in the [docs/](docs/) folder and run the following command to generate the docs (after installing mkdocs via `pip install mkdocs-material`): +The docs are generated using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To change the docs, edit the files in the [docs/](https://github.com/nextflow-io/nf-co2footprint/tree/master/docs) folder and run the following command to generate the docs (after installing mkdocs via `pip install mkdocs-material`): ```bash mkdocs serve diff --git a/docs/usage/parameters.md b/docs/usage/parameters.md index 5edd3e1..37220b2 100644 --- a/docs/usage/parameters.md +++ b/docs/usage/parameters.md @@ -37,7 +37,7 @@ Default: 475. - `location`: location code to automatically retrieve a location-specific CI value. For countries, these are [ISO alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). For regions, it’s the ISO alpha-2 code for the country, followed by an identifier for the state, e.g. US-CA for “California, USA”. -You can find the available data [here](../../plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv). +You can find the available data [here](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv). Mutually exclusive with the `ci` parameter. Default: `null`. - `pue`: power usage effectiveness, efficiency coefficient of the data centre. @@ -47,7 +47,7 @@ Default: 0.3725. - `customCpuTdpFile`: Input CSV file containing custom CPU TDP data. This should contain the following columns: `model`,`TDP`,`n_cores`,`TDP_per_core`. Note that this overwrites TDP values for already provided CPU models. -You can find the by default used TDP data [here](../../plugins/nf-co2footprint/src/resources/TDP_cpu.v2.2.csv). +You can find the by default used TDP data [here](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/TDP_cpu.v2.2.csv). Default: `null`. - `ignoreCpuModel`: ignore the retrieved Nextflow trace `cpu_model` name and use the default CPU power draw value. This is useful, if the cpu model information provided by the linux kernel is not correct, for example, in the case of VMs emulating a different CPU architecture. diff --git a/mkdocs.yml b/mkdocs.yml index 6169abb..92c0772 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_name: nf-co2footprint repo_name: nextflow-io/nf-co2footprint repo_url: https://github.com/nextflow-io/nf-co2footprint site_url: https://nextflow-io.github.io/nf-co2footprint/ -edit_uri: edit/dev/docs/ # TODO: change on release to edit/main/docs/ +edit_uri: edit/master/docs/ nav: - Home: From 4c222af15ae2a4ab08d72d06b0a0a5481b7ca9c2 Mon Sep 17 00:00:00 2001 From: Till Englert Date: Thu, 12 Dec 2024 11:12:17 +0100 Subject: [PATCH 03/10] Add configuration page Signed-off-by: Till Englert --- docs/usage/configuration.md | 79 +++++++++++++++++++++++++++++++++++++ docs/usage/parameters.md | 19 --------- mkdocs.yml | 1 + 3 files changed, 80 insertions(+), 19 deletions(-) create mode 100644 docs/usage/configuration.md diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md new file mode 100644 index 0000000..a91010f --- /dev/null +++ b/docs/usage/configuration.md @@ -0,0 +1,79 @@ +--- +title: Configuration +description: Configuration of the nf-co2footprint plugin +--- + +# Configuration of the nf-co2footprint plugin + +## General usage +To test if the plugin works on your system please follow the quick start guide ([Quick Start](https://nextflow-io.github.io/nf-co2footprint/#quick-start)) on a small pipeline like [nextflow-io/hello](https://github.com/nextflow-io/hello). + +If the plugin works and a html report is being produced you can start making the output meaningful for your specific run, by using a customized configuration file. The configuration file could look something like this: + +```groovy title="nextflow.config" +plugins { + id 'nf-co2footprint@1.0.0-beta' +} + +def co2_timestamp = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss') + +co2footprint { + traceFile = "${params.outdir}/co2footprint/co2footprint_trace_${co2_timestamp}.txt" + reportFile = "${params.outdir}/co2footprint/co2footprint_report_${co2_timestamp}.html" + summaryFile = "${params.outdir}/co2footprint/co2footprint_summary_${co2_timestamp}.txt" + ci = 300 + pue = 1.4 +} +``` + +Include the config file for your pipeline run using the `-c` Nextflow parameter, for example as follows: + +```bash +nextflow run nextflow-io/hello -c nextflow.config +``` + +In this case the plugin will create 3 outputfiles within the outdir, which is set for the pipeline run. Also a custom carbon intensity (CI) is set and a Power Usage Efficiency (PUE) factor. To check all available parameters you can visit: [Parameters](https://nextflow-io.github.io/nf-co2footprint/usage/parameters/). The CI and PUE values will influence the CO2 footprint the most and are dependent on where your pipeline is running. The CI reflects the used energy sources, while the PUE describes how efficiently the Power is used in regard to computing power. + +If you are using a local cluster you can usually find out your specific PUE at the system administrators or system managers. Otherwise a [yearly worldwide average](https://www.statista.com/statistics/1229367/data-center-average-annual-pue-worldwide/) of 1.56 could be used, for initial runs. + +For the CI you can check available regions at the provided CI table [here](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv), otherwise you can use data from [ElecricityMaps](https://app.electricitymaps.com/map/24h), to find out your CI. + +## Cloud computations + +At the moment the nf-co2footprint can not natively support cloud computations. + +!!! warning + + This is not untested and might not work as, but cloud native support will be implemented soon. + +If you are still keen to get insights into your CO2 you could try to find out the following and append it to your config: + +- The location and hereby CI of your instance. +- The PUE of the data center, where the instance is located +- The power draw per core of your selected instance. +- If available the power draw of the memory per GB. + +Your configuration could look something like: + +```groovy title="nextflow_cloud.config" +plugins { + id 'nf-co2footprint@1.0.0-beta' +} + +def co2_timestamp = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss') + +co2footprint { + traceFile = "${params.outdir}/co2footprint/co2footprint_trace_${co2_timestamp}.txt" + reportFile = "${params.outdir}/co2footprint/co2footprint_report_${co2_timestamp}.html" + summaryFile = "${params.outdir}/co2footprint/co2footprint_summary_${co2_timestamp}.txt" + ci = 300 + pue = 1.4 + ignoreCpuModel = true + powerdrawCpuDefault = 8 + powerdrawMem = 0.3725 +} +``` + +## GPU computations + +So far tracking of GPU driven computations are not implemented, and functionality might be impaired. \ No newline at end of file diff --git a/docs/usage/parameters.md b/docs/usage/parameters.md index 37220b2..f6dc752 100644 --- a/docs/usage/parameters.md +++ b/docs/usage/parameters.md @@ -5,25 +5,6 @@ description: Customising parameters for the CO2e calculation. ## Customising parameters -You can adjust the nf-co2footprint plugin parameters in your config file as follows: - -```groovy title="nextflow.config" -def co2_timestamp = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss') - -co2footprint { - traceFile = "${params.outdir}/co2footprint_trace_${co2_timestamp}.txt" - reportFile = "${params.outdir}/co2footprint_report_${co2_timestamp}.html" - ci = 300 - pue = 1.4 -} -``` - -Include the config file for your pipeline run using the `-c` Nextflow parameter, for example as follows: - -```bash -nextflow run nextflow-io/hello -c nextflow.config -``` - The following parameters are currently available: - `traceFile`: Name of the TXT carbon footprint report containing the energy consumption, the estimated CO2 emission and other relevant metrics for each task. diff --git a/mkdocs.yml b/mkdocs.yml index 92c0772..f305e66 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,7 @@ nav: - index.md - co2footprint.md - Usage: + - usage/configuration.md - usage/parameters.md - Contributing: - contributing/setup.md From 625004a5980d45120aa369dac85c06cf2ac896df Mon Sep 17 00:00:00 2001 From: Till Englert Date: Thu, 12 Dec 2024 11:37:10 +0100 Subject: [PATCH 04/10] Include output page Signed-off-by: Till Englert --- docs/usage/output.md | 15 +++++++++++++++ mkdocs.yml | 1 + 2 files changed, 16 insertions(+) create mode 100644 docs/usage/output.md diff --git a/docs/usage/output.md b/docs/usage/output.md new file mode 100644 index 0000000..fae0e68 --- /dev/null +++ b/docs/usage/output.md @@ -0,0 +1,15 @@ +--- +title: Output +description: Output of the nf-co2footprint plugin. +--- + +## Output + +The nf-co2footprint plugin creates three output files: + +- `traceFile`: 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. +- `summaryFile`: The summary file includes the total CO2 footprint of the workflow run and the configuration used for the plugin. +- `reportFile`: The html report file includes data from trace and summary file and also summary figures of the executed tasks. + + + diff --git a/mkdocs.yml b/mkdocs.yml index f305e66..b796168 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,7 @@ nav: - Usage: - usage/configuration.md - usage/parameters.md + - usage/output.md - Contributing: - contributing/setup.md From ac2f79c5a7de9eadd3a8f446b368c93f19d980ba Mon Sep 17 00:00:00 2001 From: Till Englert Date: Fri, 13 Dec 2024 11:14:48 +0100 Subject: [PATCH 05/10] Messed up the warning for cloud config Signed-off-by: Till Englert --- docs/usage/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index a91010f..09ea8da 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -44,7 +44,7 @@ At the moment the nf-co2footprint can not natively support cloud computations. !!! warning - This is not untested and might not work as, but cloud native support will be implemented soon. + This is not tested and might not work as intended, but cloud native support will be implemented soon. If you are still keen to get insights into your CO2 you could try to find out the following and append it to your config: From 1924907bbe0989ee6be0a45f104c8865e8901ad7 Mon Sep 17 00:00:00 2001 From: Till Englert Date: Fri, 13 Dec 2024 11:16:55 +0100 Subject: [PATCH 06/10] Include versioned github links to CI and TDP table Co-authored-by: Sabrina Krakau Signed-off-by: Till Englert --- docs/usage/configuration.md | 2 +- docs/usage/parameters.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 09ea8da..cb1ba06 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -36,7 +36,7 @@ In this case the plugin will create 3 outputfiles within the outdir, which is se If you are using a local cluster you can usually find out your specific PUE at the system administrators or system managers. Otherwise a [yearly worldwide average](https://www.statista.com/statistics/1229367/data-center-average-annual-pue-worldwide/) of 1.56 could be used, for initial runs. -For the CI you can check available regions at the provided CI table [here](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv), otherwise you can use data from [ElecricityMaps](https://app.electricitymaps.com/map/24h), to find out your CI. +For the CI you can check available regions at the provided CI table [here](https://github.com/nextflow-io/nf-co2footprint/blob/1.0.0-beta/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv), otherwise you can use data from [ElecricityMaps](https://app.electricitymaps.com/map/24h), to find out your CI. ## Cloud computations diff --git a/docs/usage/parameters.md b/docs/usage/parameters.md index f6dc752..b4ede22 100644 --- a/docs/usage/parameters.md +++ b/docs/usage/parameters.md @@ -18,7 +18,7 @@ Default: 475. - `location`: location code to automatically retrieve a location-specific CI value. For countries, these are [ISO alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). For regions, it’s the ISO alpha-2 code for the country, followed by an identifier for the state, e.g. US-CA for “California, USA”. -You can find the available data [here](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv). +You can find the available data [here](https://github.com/nextflow-io/nf-co2footprint/blob/1.0.0-beta/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv). Mutually exclusive with the `ci` parameter. Default: `null`. - `pue`: power usage effectiveness, efficiency coefficient of the data centre. @@ -28,7 +28,7 @@ Default: 0.3725. - `customCpuTdpFile`: Input CSV file containing custom CPU TDP data. This should contain the following columns: `model`,`TDP`,`n_cores`,`TDP_per_core`. Note that this overwrites TDP values for already provided CPU models. -You can find the by default used TDP data [here](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/TDP_cpu.v2.2.csv). +You can find the by default used TDP data [here](https://github.com/nextflow-io/nf-co2footprint/blob/1.0.0-beta/plugins/nf-co2footprint/src/resources/TDP_cpu.v2.2.csv). Default: `null`. - `ignoreCpuModel`: ignore the retrieved Nextflow trace `cpu_model` name and use the default CPU power draw value. This is useful, if the cpu model information provided by the linux kernel is not correct, for example, in the case of VMs emulating a different CPU architecture. From a9d6bc88b3e3a4037bc58a927f049a8e2d5dbb77 Mon Sep 17 00:00:00 2001 From: Till Englert Date: Fri, 13 Dec 2024 11:19:08 +0100 Subject: [PATCH 07/10] Missed one link Co-authored-by: Sabrina Krakau Signed-off-by: Till Englert --- docs/co2footprint.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/co2footprint.md b/docs/co2footprint.md index c2eacef..320338a 100644 --- a/docs/co2footprint.md +++ b/docs/co2footprint.md @@ -35,7 +35,7 @@ This includes failed tasks as well. ## Used data -If the `location` parameter is specified, the plugin makes use of [location-specific CI data](https://github.com/nextflow-io/nf-co2footprint/blob/master/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv) that was copied from the Green Algorithms project [green-algorithms-tool/data](https://github.com/GreenAlgorithms/green-algorithms-tool/tree/master/data). +If the `location` parameter is specified, the plugin makes use of [location-specific CI data](https://github.com/nextflow-io/nf-co2footprint/blob/1.0.0-beta/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv) that was copied from the Green Algorithms project [green-algorithms-tool/data](https://github.com/GreenAlgorithms/green-algorithms-tool/tree/master/data). The CPU TDP data from the Green Algorithms project is used to retrieve model-specific CPU power draw values. From 6fbd4fe50d901a3c19c3ed2a5d51035c54460699 Mon Sep 17 00:00:00 2001 From: Bastian Eisenmann Date: Thu, 19 Dec 2024 12:44:59 +0100 Subject: [PATCH 08/10] update documentation Signed-off-by: Bastian Eisenmann --- docs/usage/configuration.md | 2 +- docs/usage/output.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index cb1ba06..f095e82 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -8,7 +8,7 @@ description: Configuration of the nf-co2footprint plugin ## General usage To test if the plugin works on your system please follow the quick start guide ([Quick Start](https://nextflow-io.github.io/nf-co2footprint/#quick-start)) on a small pipeline like [nextflow-io/hello](https://github.com/nextflow-io/hello). -If the plugin works and a html report is being produced you can start making the output meaningful for your specific run, by using a customized configuration file. The configuration file could look something like this: +You can adjust the nf-co2footprint plugin parameters in your config file as follows: ```groovy title="nextflow.config" plugins { diff --git a/docs/usage/output.md b/docs/usage/output.md index fae0e68..60b9fb7 100644 --- a/docs/usage/output.md +++ b/docs/usage/output.md @@ -7,9 +7,9 @@ description: Output of the nf-co2footprint plugin. The nf-co2footprint plugin creates three output files: -- `traceFile`: 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. +- `traceFile`: 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. - `summaryFile`: The summary file includes the total CO2 footprint of the workflow run and the configuration used for the plugin. -- `reportFile`: The html report file includes data from trace and summary file and also summary figures of the executed tasks. +- `reportFile`: The HTML report contains information about the carbon footprint of the whole pipeline run as well as plots showing the distributions of the CO2 emissions for the different processes. Additionally, it contains a table with the metrics for all individual tasks. From 3c63b0ff4c2bf30f23d810b0b1446ebb6701f2bc Mon Sep 17 00:00:00 2001 From: Bastian Eisenmann Date: Thu, 19 Dec 2024 15:13:16 +0100 Subject: [PATCH 09/10] update documentation Signed-off-by: Bastian Eisenmann --- docs/usage/configuration.md | 7 ++----- docs/usage/parameters.md | 5 +++-- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index f095e82..22bb41a 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -32,11 +32,8 @@ Include the config file for your pipeline run using the `-c` Nextflow parameter, nextflow run nextflow-io/hello -c nextflow.config ``` -In this case the plugin will create 3 outputfiles within the outdir, which is set for the pipeline run. Also a custom carbon intensity (CI) is set and a Power Usage Efficiency (PUE) factor. To check all available parameters you can visit: [Parameters](https://nextflow-io.github.io/nf-co2footprint/usage/parameters/). The CI and PUE values will influence the CO2 footprint the most and are dependent on where your pipeline is running. The CI reflects the used energy sources, while the PUE describes how efficiently the Power is used in regard to computing power. - -If you are using a local cluster you can usually find out your specific PUE at the system administrators or system managers. Otherwise a [yearly worldwide average](https://www.statista.com/statistics/1229367/data-center-average-annual-pue-worldwide/) of 1.56 could be used, for initial runs. - -For the CI you can check available regions at the provided CI table [here](https://github.com/nextflow-io/nf-co2footprint/blob/1.0.0-beta/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv), otherwise you can use data from [ElecricityMaps](https://app.electricitymaps.com/map/24h), to find out your CI. +In this case the plugin will create 3 outputfiles within the outdir, which is set for the pipeline run. Also a custom carbon intensity (CI) is set and a Power Usage Efficiency (PUE) factor. To check all available parameters you can visit: [Parameters](https://nextflow-io.github.io/nf-co2footprint/usage/parameters/). +The CI and PUE values will influence the CO2 footprint the most and are dependent on where your pipeline is running. The CI reflects the used energy sources, while the PUE describes how efficiently the Power is used in regard to computing power. ## Cloud computations diff --git a/docs/usage/parameters.md b/docs/usage/parameters.md index b4ede22..d08e8eb 100644 --- a/docs/usage/parameters.md +++ b/docs/usage/parameters.md @@ -13,7 +13,8 @@ Default: `co2footprint_trace_.txt`. Default: `co2footprint_summary_.txt`. - `reportFile`: Name of the HTML report containing information about the entire carbon footprint, overview plots and more detailed task-specific metrics. Default: `co2footprint_report_.html`. -- `ci`: carbon intensity of the respective energy production. Mutually exclusive with the `location` parameter. +- `ci`: Carbon intensity of the respective energy production. Available regions can be found [here](https://github.com/nextflow-io/nf-co2footprint/blob/1.0.0-beta/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv), otherwise you can use data from [ElecricityMaps](https://app.electricitymaps.com/map/24h), to find out locally more accurate CI. +Mutually exclusive with the `location` parameter. Default: 475. - `location`: location code to automatically retrieve a location-specific CI value. For countries, these are [ISO alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). @@ -21,7 +22,7 @@ For regions, it’s the ISO alpha-2 code for the country, followed by an identif You can find the available data [here](https://github.com/nextflow-io/nf-co2footprint/blob/1.0.0-beta/plugins/nf-co2footprint/src/resources/CI_aggregated.v2.2.csv). Mutually exclusive with the `ci` parameter. Default: `null`. -- `pue`: power usage effectiveness, efficiency coefficient of the data centre. +- `pue`: Power usage effectiveness, efficiency coefficient of the data centre. For local cluster you can usually find out your specific PUE at the system administrators or system managers. Also the current [yearly worldwide average](https://www.statista.com/statistics/1229367/data-center-average-annual-pue-worldwide/) could be used. Default: 1.67. - `powerdrawMem`: power draw from memory. Default: 0.3725. From 94454068cc26a9495977e3c9e0d668c7f7aa6141 Mon Sep 17 00:00:00 2001 From: Bastian Eisenmann Date: Thu, 19 Dec 2024 16:35:08 +0100 Subject: [PATCH 10/10] update documentation Signed-off-by: Bastian Eisenmann --- docs/usage/configuration.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 22bb41a..5a9afb7 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -32,9 +32,6 @@ Include the config file for your pipeline run using the `-c` Nextflow parameter, nextflow run nextflow-io/hello -c nextflow.config ``` -In this case the plugin will create 3 outputfiles within the outdir, which is set for the pipeline run. Also a custom carbon intensity (CI) is set and a Power Usage Efficiency (PUE) factor. To check all available parameters you can visit: [Parameters](https://nextflow-io.github.io/nf-co2footprint/usage/parameters/). -The CI and PUE values will influence the CO2 footprint the most and are dependent on where your pipeline is running. The CI reflects the used energy sources, while the PUE describes how efficiently the Power is used in regard to computing power. - ## Cloud computations At the moment the nf-co2footprint can not natively support cloud computations.