Skip to content

Commit 1e443cc

Browse files
committed
Small updates
1 parent 1945758 commit 1e443cc

File tree

9 files changed

+48
-14
lines changed

9 files changed

+48
-14
lines changed

_data/navigation.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ training:
2727
- title: Ten Simple Rules
2828
url: https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1009324
2929
- title: "Recordings"
30+
children:
31+
- title: "EMBL-EBI webinar"
32+
url: https://www.ebi.ac.uk/training/events/environmental-impact-computational-biology/
3033

3134
talks:
3235
- title: "To jump straight to the latest recordings and slides:"

_pages/GA4HPC/GA4HPC.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ At this stage, the script works on any HPC server using [SLURM](https://slurm.sc
3131

3232
## How to install it
3333

34-
It doesn't require any particular permissions, you just need to copy the GitHub repository on your HPC drive, enter some information about your data centre, and you're good to go! [Tutorial here](/GA4HPC/install)
34+
It doesn't require any particular permissions, you just need to copy the GitHub repository on your HPC drive, enter some information about your data centre, and you're good to go! [Tutorial here]({% link _pages/GA4HPC/GA4HPC_installation.md %})
3535

3636
## How to use it
3737

3838
Anyone with access to `the_shared_directory` where the script is located can run the calculator,
3939
by running the same command, with various options available:
4040

4141
```
42-
usage: GreenAlgorithms_global.py [-h] [-S STARTDAY] [-E ENDDAY] [--filterCWD]
42+
usage: myCarbonFootprint.sh [-h] [-S STARTDAY] [-E ENDDAY] [--filterCWD]
4343
[--filterJobIDs FILTERJOBIDS]
4444
[--filterAccount FILTERACCOUNT] [--reportBug]
4545
[--reportBugHere]
@@ -61,6 +61,16 @@ optional arguments:
6161
Comma seperated list of Job IDs you want to filter on.
6262
--filterAccount FILTERACCOUNT
6363
Only consider jobs charged under this account
64+
--customSuccessStates CUSTOMSUCCESSSTATES
65+
Comma-separated list of job states. By default, only
66+
jobs that exit with status CD or COMPLETED are
67+
considered succesful (PENDING, RUNNING and REQUEUD are
68+
ignored). Jobs with states listed here will be
69+
considered successful as well (best to list both
70+
2-letter and full-length codes. Full list of job
71+
states:
72+
https://slurm.schedmd.com/squeue.html#SECTION_JOB-
73+
STATE-CODES
6474
--reportBug In case of a bug, this flag logs jobs informations so
6575
that we can fix it. Note that this will write out some
6676
basic information about your jobs, such as runtime,
@@ -78,8 +88,10 @@ optional arguments:
7888
### Limitations to keep in mind
7989

8090
- The workload manager doesn't alway log the exact CPU usage time, and when this information is missing, we assume that all cores are used at 100%.
81-
- For now, we assume that GPU jobs only use 1 GPU and the GPU is used at 100% (as the information needed for more accurate measurement is not available)
91+
- For now, we assume that GPU jobs only use 1 GPU and the GPU is used at 100%, as the information needed for more accurate measurement is not always available.
92+
8293
(both of these may lead to slightly overestimated carbon footprints, although the order of magnitude is likely to be correct)
94+
8395
- Conversely, the wasted energy due to memory overallocation may be largely underestimated, as the information needed is not always logged.
8496

8597
## Report bugs
@@ -88,7 +100,7 @@ If you spot any bugs, or would like new features, just [open a new issue on GitH
88100

89101
## How to modify the script for my cluster?
90102

91-
See the ["Edit code and contribute"](/GA4HPC/edit) page on how to modify the code and share your improvements with other users.
103+
See the ["Edit code and contribute"]({% link _pages/GA4HPC/GA4HPC_editCode.md %}) page on how to modify the code and share your improvements with other users.
92104

93105
## Licence
94106

_pages/GA4HPC/GA4HPC_editCode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc: true
99
---
1010

1111
You may need to edit the tool, either to make it work with the specifities of your cluster, or just to add new features.
12-
Eitherway, please consider submitting some pull requests to the GitHub to share these edits with other users!
12+
Eitherway, please consider submitting some pull requests to [the GitHub](https://github.com/GreenAlgorithms/GreenAlgorithms4HPC) to share these edits with other users!
1313

1414
There are some example of intermediary files [here](https://github.com/GreenAlgorithms/GreenAlgorithms4HPC/tree/main/example_files/).
1515

_pages/Training/training.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,34 @@ blog_articles:
2222
url: /training/
2323
btn_label: "Learn more"
2424
btn_class: "btn--primary"
25+
26+
feature_row_1:
27+
- image_path: assets/images/EMBL-EBI webinar.png
28+
alt: "The carbon footprint of computational biology, an EMBL-EBI training webinar."
29+
title: "A training webinar with EMBL-EBI"
30+
excerpt: "We did a webinar with EMBL-EBI's training team, it's still available with the slides!"
31+
url: "https://www.ebi.ac.uk/training/events/environmental-impact-computational-biology/"
32+
btn_label: "Learn more"
33+
btn_class: "btn--primary"
2534
---
2635

2736
We regroup here resources that can be used to learn more about green computing.
2837

2938
If you just want a summary of what you can do today, __check out our [Ten Simple Rules article](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1009324)__!
3039
{: .notice--info}
3140

41+
<!-- :hourglass: &nbsp; More coming soon &nbsp; :hourglass:
42+
{: .notice--warning} -->
43+
44+
{% include feature_row id="feature_row_1" type="left"%}
45+
3246
<!-- # Tutorials
3347
3448
{% include feature_row id="blog_articles" type="left" %} -->
3549

36-
:hourglass: &nbsp; More coming soon &nbsp; :hourglass:
37-
{: .notice--warning}
38-
3950
## Other resources available online
4051

4152
- You can check the carbon intensity of a location live on [electricitymaps.com](https://app.electricitymaps.com/map).
4253
- To tackle the carbon footprint of "wet" labs, there is the [LEAF framework](https://www.ucl.ac.uk/sustainable/leaf/take-part-leaf).
54+
- The [1point5 lab](https://labos1point5.org/) initiative is an international, cross-disciplinary collective of French academics who share a common goal: to better understand and reduce the environmental impact of research.
4355
- Curious about the energy usage of Bitcoin? There is a tool for that [here](https://ccaf.io/cbeci/index).

_pages/app_userGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ sidebar:
2828

2929
## Methods and data
3030

31-
The methodology behind the Green Algorithms project is described in [our publication](https://onlinelibrary.wiley.com/doi/10.1002/advs.202100707) (go [here](/publications/) for the full list of publications related to this project).
31+
The methodology behind the Green Algorithms project is described in [our publication](https://onlinelibrary.wiley.com/doi/10.1002/advs.202100707) (go [here]({% link _pages/publications.md %}) for the full list of publications related to this project).
3232

3333
All the data used for the calculator are in the [`/data`](https://github.com/GreenAlgorithms/green-algorithms-tool/tree/master/data) directory on GitHub.
3434

_pages/talks.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,24 @@ permalink: /talks/
33

44
title: Talks
55

6+
header:
7+
overlay_image: assets/images/stripes_banner_1.png
8+
overlay_filter: linear-gradient(rgba(255, 255,255, 0), 20%, rgba(255, 255, 255, 1))
9+
text_color: rgb(80, 80, 80)
10+
611
sidebar:
712
nav: talks
813

9-
toc: true
14+
toc: true
1015
---
1116

1217
List of talks about the Green Algorithms projects, with links to slide decks and recording when available.
1318

1419
## 2022
1520

16-
- __AI-2022__ British Computer Society's International Conference on Artificial Intelligence: talk at the [_Sustainability & AI_ workshop](http://bcs-sgai.org/ai2022/?section=workshops) (December 2022). Slides [here](https://drive.google.com/file/d/15KP3gxyuu23MW6WaNAW867Ti4RBBZClP/view?usp=share_link).
21+
- __AI-2022__ British Computer Society's International Conference on Artificial Intelligence - [_Sustainability & AI_ workshop](http://bcs-sgai.org/ai2022/?section=workshops) (December 2022). [\[slides\]](https://drive.google.com/file/d/15KP3gxyuu23MW6WaNAW867Ti4RBBZClP/view?usp=share_link).
1722

18-
- __EMBL-EBI webinar__ on the carbon footprint footprint of computational biology (November 2022). Recording [here](https://www.ebi.ac.uk/training/events/environmental-impact-computational-biology/) or [here on YouTube](https://www.youtube.com/watch?v=Kl64yn1eDUo) and slides [here](https://drive.google.com/file/d/1pklCNNXAFadjVwCMj0draIt8nL_89Tx0/view?usp=share_link).
23+
- __EMBL-EBI webinar__ on the carbon footprint footprint of computational biology (November 2022). [\[recording\]](https://www.ebi.ac.uk/training/events/environmental-impact-computational-biology/) [\[YouTube\]](https://www.youtube.com/watch?v=Kl64yn1eDUo) [\[slides\]](https://drive.google.com/file/d/1pklCNNXAFadjVwCMj0draIt8nL_89Tx0/view?usp=share_link).
1924

2025
## 2021
2126

assets/images/EMBL-EBI webinar.png

471 KB
Loading

assets/images/raw_images/.DS_Store

6 KB
Binary file not shown.

index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ feature_row_1:
2525
- image_path: /assets/images/GAapp_16x9.jpg
2626
alt: "Screenshot of the green algorithms calculator."
2727
title: "The online calculator"
28-
excerpt: "A tool to easily estimate the carbon footprint of a project."
28+
excerpt: "A tool to easily estimate the carbon footprint of a computation."
2929
url: "/app-user-guide/"
3030
btn_label: "Learn more"
3131
btn_class: "btn--primary"
@@ -65,12 +65,14 @@ gallery_logos:
6565
__Are you looking for the online calculator?__ It's been moved to [calculator.green-algorithms.org](http://calculator.green-algorithms.org)
6666
{: .notice--success}
6767

68-
__:hourglass: This website is a work in progress, and we will keep adding content in the coming weeks!__
68+
__:hourglass: This website is a work in progress, and we will keep adding content in the coming weeks/months!__ Comments/suggestions can be made [here](https://github.com/GreenAlgorithms/GreenAlgorithms.github.io/issues).
6969
{: .notice--warning}
7070

7171
The Green Algorithms project aims at promoting more environmentally sustainable computational science. It regroups calculators that researchers can use to estimate the carbon footprint of their projects, tips on how to be more environmentally friendly, training material, past talks etc.
7272

73+
<!-- TODO add news -->
7374

75+
<!-- TODO do the google SEO -->
7476

7577
<!-- ## Estimating the carbon footprint of algorithms -->
7678

0 commit comments

Comments
 (0)