Diagnostic for calculating Lamb Weathertypes #3691

thomaskroi1996 · 2024-06-27T08:52:52Z

Hello everyone!

At the Wegener Center in Graz, Austria, we have been doing some research with Lamb Weathertypes for quite some while now, and recently started developing a diagnostic for ESMValTool to make things easier, and potentially be of use for others!

The features are:

Calculate the 27 Lamb Weathertypes over a region specified in the corresponding recipe
Plot means, anomalies as well as standard deviations for those weathertypes for psl, tas and prcp
Combining the weathertypes based on precipitation patterns over an area specified in the corresponding recipe as done here: https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2020JD032824 (Table 2)
Create the same plots for those combined weathertypes

The weathertypes are calculated for ERA5 and model data, and the precipitation data for correlation calculations are taken from ERA5 and E-OBS.

The branch we are working on is called weathertyping_wegc.

We are happy to discuss this project with the community, get some feedback and features you would like to see!

Thank you very much and with kind regards,

Thomas Kroißenbrunner and Martin Jury

Before you get started

☝ Create an issue to discuss what you are going to do

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.

🛠 This pull request has a descriptive title
🛠 Code is written according to the code quality guidelines
🛠 Documentation is available
🛠 Tests run successfully
🛠 The list of authors is up to date
🛠 Any changed dependencies have been added or removed correctly
🛠 All checks below this pull request were successful

New or updated recipe/diagnostic

🧪 Recipe runs successfully
🧪 Recipe is well documented
🧪 Figure(s) and data look as expected from literature
🛠 Provenance information has been added

New or updated data reformatting script

🛠 Documentation is available
🛠 The dataset has been added to the CMOR check recipe
🛠 The dataset has been added to the shared data pools of DKRZ and Jasmin by the @ESMValGroup/OBS-maintainers team
🧪 Numbers and units of the data look physically meaningful

valeriupredoi · 2024-06-27T11:51:12Z

@thomaskroi1996 glad to see this in PR form, well done 👏 🍺 I can perform a technical review of it, but for a scientific review, I'd suggest we think who's the closest expert amongst us to perform the review. Just a couple questions before the review, please:

are you happy to have this reviewed now, or you still working on it? If work is still to be performed, then I'd recommend you convert this PR to a Draft PR, and when it's ready, make it back ready for review;
to find the best scientific reviewers, it'd be good if you could suggest one or more folks that already have experience with this type of diagnostic, if not maybe we can ask the list (scientific reviewers, which I can invoke via a GitHub tag)

Cheers 🍺

thomaskroi1996 · 2024-06-27T14:42:52Z

@valeriupredoi Hey there! I am still doing some work, and definitely have to do all the tests, therfore I will convert it to a draft now, thank you so much!
As for the 2nd point, I can talk to my supervisor next week, and then maybe we have some suggestions for scientific reviewers, in which case I will reply to you here again!

Cheers! 🍻

thomaskroi1996 · 2024-08-19T08:51:17Z

@valeriupredoi Hello! :) I have now finished all the main work now, and implemented everything we wanted to! Now I think it is time for the technical review, correct? Thank you so much for all the help!

valeriupredoi · 2024-09-19T14:42:54Z

many thanks @thomaskroi1996 - and my apologies, I was on summer holidays until a few days ago, let me do a tech review now, cheers 🍺

valeriupredoi

first off - the nagging bits: could you please have a look at the code formatting - we are currently using flake8 to check for it, so it'd be good if you ran flake8 inside your dir once, to see the bits it complains about, alternatively please have a look at the list of issues it reports on the CircleCI output here

valeriupredoi

Hi again @thomaskroi1996 very many thanks for this considerable amount of work! I had a look over the added files - all looks great already, and have a couple relatively minor points, in addition to the few review remarks I posted inline code:

you mention E-OBS, do you plan on writing a cmorizer script for that OBS dataset too?
API documentation for your public functions looks good but it would have been nice to have it in Numpy-style format - no biggie though, because we let the users choose the way they document their code, since we don't build API docs from diagnostic
(the more important point) would it be possible to compact all those data-typed recipes in one single one, or, at least, a couple of them? I see they are differentiated by the input data - you could allow multiple diagnostics typed on various datasets into one single recipe - I reckon that'd be a bit more convenient both for the users, and for us, when we test a new ESMValTool version - we'd not have to run a busload of recipes, but just one 😀

valeriupredoi · 2024-09-19T15:37:10Z

esmvaltool/diag_scripts/weathertyping/weathertyping.py

+from esmvaltool.diag_scripts.shared import (
+    run_diagnostic,
+)
+


if you could please run isort on this, that'll fix the import order; also - are you importing everything from wt_utils ? - could do the otherwise bad from wt_utils import * if so, and save the reader looking at a huge imports list 😁

valeriupredoi · 2024-09-19T15:39:59Z

doc/sphinx/source/recipes/recipe_weathertyping.rst

+--------
+
+A diagnostic to calculate Lamb weathertypes over a given region. Furthermore, 
+correlations between weathertypes and precipitation patterns over a given are can be calculated 


Suggested change

correlations between weathertypes and precipitation patterns over a given are can be calculated

correlations between weathertypes and precipitation patterns over a given area can be calculated

valeriupredoi · 2024-09-19T16:04:47Z

@ESMValGroup/scientific-lead-development-team any of you good folk want to have a look at this new diagnostic, and sign up for a scientific review, please? It looks very cool, but unfortunately, I am no expert in weather types, all I know is "rainy" in Britain 🇬🇧 😁

bettina-gier · 2024-09-19T16:08:54Z

I'll look at it tomorrow, not an expert in weather types but can still see if each part is scientifically sound, esp if there's a linked paper to compare it to!

valeriupredoi · 2024-09-19T16:12:31Z

I'll look at it tomorrow, not an expert in weather types but can still see if each part is scientifically sound, esp if there's a linked paper to compare it to!

wonderful, many thanks, Tina 🍺

bettina-gier

This looks like a great contribution to the ESMValTool! I gotta admit I didn't read all the python code in the utils file, but the formulas seem like the paper you linked and the plots my run got looked like the ones you put in the documentation - units look fine to me and patterns reasonable. So general scientific review gets a big check. I've got some general points though:

On the technical side (YO @valeriupredoi I thought I was doing the sci review!):

Your provenance doesn't seem right, I got the files in the wrong folder (where I started the diagnostics), and I'm not sure which of your output files they actually belong to, calling them the same as your output files is recommended. I think provenance for the plots is missing (best to include it in your plotting functions).
You're outputting both pdf and png files hardcoded, while we have the input_file_type variable in the User config, would be cool to use that instead

On the scientific side, I've got less required changes since the output looks reasonable, but maybe some more quality of life:

Your two observational datasets seem pretty hardcoded, how much of that is that required or could you (within reasonable time) check if you could support other observations/reanalysis? The more modular the better.
Could you put more information on the selection of the extracted region, what is necessary for the computation, what for the output? The recipes use two different extract_regions. It might be nice to know for the user which of these they can change.
Similarly, some of your recipes use different timeframes - obviously to account for the available data - but none of your filenames or plot titles mention the period used for the computation, just "mean". I think this would be nice to add. Maybe also the name of the dataset in the plottitle, the first two plots in the documentation is very similar until you read the caption.

doc/sphinx/source/recipes/recipe_weathertyping.rst

bettina-gier · 2024-09-20T14:31:59Z

doc/sphinx/source/recipes/recipe_weathertyping.rst

+
+   * correlation_threshold: correlation threshold for selecting similar WT pairs, only needed if automatic_slwt==True and predefined_slwt==False. default=0.9
+   * rmse_threshold: rmse threshold for selecting similar WT pairs, only needed if automatic_slwt==True and predefined_slwt==False. default=0.002
+   * plotting: if true, create plots of means, anomalies and std for psl, tas, prcp


Suggested change

* plotting: if true, create plots of means, anomalies and std for psl, tas, prcp

* plotting: if true, create plots of means, anomalies and std for psl, tas, pr

bettina-gier · 2024-09-20T14:35:18Z

doc/sphinx/source/recipes/recipe_weathertyping.rst

+(2) see headers of reformat scripts for non-obs4MIPs data for download
+instructions.*
+
+* E-OBS: European Climate Assessment & Dataset gridded observationl daily precipitation sum


Suggested change

* E-OBS: European Climate Assessment & Dataset gridded observationl daily precipitation sum

* E-OBS: European Climate Assessment & Dataset gridded daily precipitation sum

add ERA5 as well

bettina-gier · 2024-09-20T14:42:09Z

esmvaltool/recipes/recipe_weathertyping.yml

+
+  description: |
+    A diagnostic to calculate Lamb weathertypes over a given region. Furthermore, 
+    correlations between weathertypes and precipitation patterns over a given are can be calculated 


Suggested change

correlations between weathertypes and precipitation patterns over a given are can be calculated

correlations between weathertypes and precipitation patterns over a given area can be calculated

bettina-gier · 2024-09-20T14:53:56Z

esmvaltool/recipes/recipe_weathertyping.yml

+        automatic_slwt: true
+        #predefined_slwt: {1: [1, 2, 7, 8, 10, 11, 18, 19, 20, 25, 26], 2: [3, 13], 3: [4, 5, 6, 9, 14, 15, 16, 17], 4: [24, 23]}
+        plotting: true
+        script: ../diag_scripts/weathertyping/weathertyping.py


Suggested change

script: ../diag_scripts/weathertyping/weathertyping.py

script: weathertyping/weathertyping.py

ESMValTool automatically looks in the diag_scripts folder for the diagnostics scripts, no need for a relative path from the recipe

bettina-gier · 2024-09-20T14:56:48Z

esmvaltool/diag_scripts/weathertyping/wt_utils.py

+        plt.savefig(f'{output_path}/{dataset_name}_{ensemble}_'
+                    f'{wt_string}_rel_occurrence.png')
+        plt.savefig(f'{output_path}/{dataset_name}_{ensemble}_'
+                    f'{wt_string}_rel_occurrence.pdf')


I would suggest to only output one plot filetype using the cfg['output_file_type'] from the user_config. You could use the get_plot_filename function from esmvaltool.diag_scripts.shared

"Figures should be saved in the plot_dir, either in both .pdf and .png format (preferred), or respect the output_file_type specified in the [User configuration file]."
I found this in the "Making a New Diagnostic or Recipe", which is why I decided to hardcode it in the first place! Writing only one plot with output_file_type would certainly save some time though!

Huh, that shows you how much I read the documentation =D I personally prefer using the output_file_type but if it says so in the documentation you can keep it if you want to make as few changes as possible.

:D Thank you for the quick reply! I think it certainly makes sense to let the user have a say in the output file type! I will also talk to my supervisor, and then decide! Thank you!

bettina-gier · 2024-09-20T15:05:14Z

esmvaltool/diag_scripts/weathertyping/wt_utils.py

+                                              ['Lamb Weathertypes'],
+                                              False, False)
+
+    log_provenance(f'{dataset}_wt_prov', cfg, provenance_record)


All your calls to log_provenance are only giving filenames without the paths, resulting in the provenance files being created in the folder where I start the tool, not together with the files.

thomaskroi1996 · 2024-09-21T08:23:34Z

@valeriupredoi @bettina-gier Hello both of you and thank you so much for the replies! Not sure how I missed that, so sorry for the late reply!

Thank you so much for the input, I will correct everything as soon as i have some time on my hands! Unfourtunately I have switched to a different project, but it should be fine to allocate some hours throughout the next weeks to work on the mistakes/improvements!

thomaskroi1996 · 2024-09-29T11:50:37Z

@valeriupredoi @bettina-gier Hello! Currently the Circle CI test seems to fail because I use "from wt_utils import *", just thought i would comment that here!

Also the minor things are dealt with now, leaving only including the possibility for more observational datasets (for which I will talk to @mwjury), and compacting the recipes!

I also need to rerun the recipes so that I can update the documentation with the new plots etc., however since I currently need our computational resources for another project, hopefully next week I can tend to it!

Thanks again for the great input! :)

valeriupredoi · 2024-10-02T15:58:33Z

@thomaskroi1996 take your time, no rush at all! I can help sometime next week too, knock off some of those Flake8 issues. You are absolutely correct - and my bad - Flake8 flags star imports - always discouraged people do that, but looks like Flake8 is now the Punisher 😁

thomaskroi1996 · 2024-10-03T11:41:28Z

@valeriupredoi Alright, over the next couple of days I will import only the necessary functions, and I only just discovered that there were more issues with the code, even though flake8 didn't output any anymore, I should have also run pytest!

One issue is "too many local variables". Those started popping up because I tried to fix "too many arguments" by passing Dicts and then reassigning them to local variables in the functions! Those are all marked as minor issues, should I fix those issues? In my opinion I think the way I have it now makes it a bit more readable and less clustered, and if I remember correctly I once saw a PR where it was said that a few of these issues are okay!

valeriupredoi · 2024-10-03T11:48:38Z

One issue is "too many local variables". Those started popping up because I tried to fix "too many arguments" by passing Dicts and then reassigning them to local variables in the functions! Those are all marked as minor issues, should I fix those issues? In my opinion I think the way I have it now makes it a bit more readable and less clustered, and if I remember correctly I once saw a PR where it was said that a few of these issues are okay!

That's great you tried to clean up, but don't worry too much about the "too many variables" linter message, scientific computing for ESMs is bound to have lots of variables anyway 🍺

thomaskroi1996 · 2024-10-03T12:17:52Z

One issue is "too many local variables". Those started popping up because I tried to fix "too many arguments" by passing Dicts and then reassigning them to local variables in the functions! Those are all marked as minor issues, should I fix those issues? In my opinion I think the way I have it now makes it a bit more readable and less clustered, and if I remember correctly I once saw a PR where it was said that a few of these issues are okay!

That's great you tried to clean up, but don't worry too much about the "too many variables" linter message, scientific computing for ESMs is bound to have lots of variables anyway 🍺

Thomas Kroissenbrunner and others added 16 commits April 27, 2024 19:40

weathertyping scripts

74ad3a1

weathertyping scripts

e548c1c

weathertyping

4e4053d

weathertyping

88cfed7

weathertyping

682e2a5

weathertyping module

fea116e

weathertyping module

65d406a

weathertyping

f1f8dea

weathertyping

05afc1b

reformatted code, added anomaly and std plots

a780ff4

reformatted coe, added anomaly and std plots

66d524c

update

085e4f2

added predefined_slwt

507434f

mainly doc, also rewrite functions

a90da22

Merge branch 'main' into weathertyping_wegc

6363728

code reformatting, documentation, bugfixes

4b7c412

thomaskroi1996 linked an issue Jun 27, 2024 that may be closed by this pull request

New recipe and diagnostic for calculating Lamb Weathertypes #3647

Open

thomaskroi1996 marked this pull request as draft June 27, 2024 14:45

thomaskroi1996 and others added 8 commits June 29, 2024 16:53

reformat

e48c391

Merge branch 'main' into weathertyping_wegc

2afe014

bugfix

b2255db

bugfix

e5a0f9c

add recipes for CMIP5, CORDEX and seasonal occurence plot

aa47dc3

add seasonal occurence plot

afd343c

new recipes

7e57854

doc update, added ensemble to plot names

6acb3f5

thomaskroi1996 marked this pull request as ready for review August 9, 2024 08:10

thomaskroi1996 and others added 3 commits September 15, 2024 17:42

bugfix

a6928c8

predefined wt

b781eee

Merge branch 'main' into weathertyping_wegc

07d9a5a

valeriupredoi requested changes Sep 19, 2024

View reviewed changes

valeriupredoi added in technical review diagnostic looking for scientific reviewer labels Sep 19, 2024

valeriupredoi added this to the v2.12.0 milestone Sep 19, 2024

bettina-gier self-assigned this Sep 19, 2024

bettina-gier requested changes Sep 20, 2024

View reviewed changes

bettina-gier added in scientific review and removed looking for scientific reviewer labels Sep 23, 2024

thomaskroi1996 added 4 commits September 24, 2024 11:17

minor corrections

97eea08

add era5 to recipe_weathertyping.rst

9c7c6ad

added timerange, fixed prov, more bugfixes

4246910

area

240bd6e

renamed vars

599dc38

thomaskroi1996 closed this Oct 3, 2024

thomaskroi1996 reopened this Oct 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Diagnostic for calculating Lamb Weathertypes #3691

Diagnostic for calculating Lamb Weathertypes #3691

thomaskroi1996 commented Jun 27, 2024 •

edited

Loading

valeriupredoi commented Jun 27, 2024

thomaskroi1996 commented Jun 27, 2024 •

edited

Loading

thomaskroi1996 commented Aug 19, 2024

valeriupredoi commented Sep 19, 2024

valeriupredoi left a comment

valeriupredoi left a comment

valeriupredoi Sep 19, 2024

valeriupredoi Sep 19, 2024

valeriupredoi commented Sep 19, 2024 •

edited

Loading

bettina-gier commented Sep 19, 2024

valeriupredoi commented Sep 19, 2024

bettina-gier left a comment

bettina-gier Sep 20, 2024

bettina-gier Sep 20, 2024

bettina-gier Sep 20, 2024

bettina-gier Sep 20, 2024

bettina-gier Sep 20, 2024

thomaskroi1996 Sep 24, 2024

bettina-gier Sep 24, 2024

thomaskroi1996 Sep 24, 2024

bettina-gier Sep 20, 2024

thomaskroi1996 commented Sep 21, 2024

thomaskroi1996 commented Sep 29, 2024

valeriupredoi commented Oct 2, 2024

thomaskroi1996 commented Oct 3, 2024

valeriupredoi commented Oct 3, 2024

thomaskroi1996 commented Oct 3, 2024

	correlations between weathertypes and precipitation patterns over a given are can be calculated
	correlations between weathertypes and precipitation patterns over a given area can be calculated

	* plotting: if true, create plots of means, anomalies and std for psl, tas, prcp
	* plotting: if true, create plots of means, anomalies and std for psl, tas, pr

	* E-OBS: European Climate Assessment & Dataset gridded observationl daily precipitation sum
	* E-OBS: European Climate Assessment & Dataset gridded daily precipitation sum

	script: ../diag_scripts/weathertyping/weathertyping.py
	script: weathertyping/weathertyping.py

Diagnostic for calculating Lamb Weathertypes #3691

Are you sure you want to change the base?

Diagnostic for calculating Lamb Weathertypes #3691

Conversation

thomaskroi1996 commented Jun 27, 2024 • edited Loading

Before you get started

Checklist

valeriupredoi commented Jun 27, 2024

thomaskroi1996 commented Jun 27, 2024 • edited Loading

thomaskroi1996 commented Aug 19, 2024

valeriupredoi commented Sep 19, 2024

valeriupredoi left a comment

Choose a reason for hiding this comment

valeriupredoi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

valeriupredoi commented Sep 19, 2024 • edited Loading

bettina-gier commented Sep 19, 2024

valeriupredoi commented Sep 19, 2024

bettina-gier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomaskroi1996 commented Sep 21, 2024

thomaskroi1996 commented Sep 29, 2024

valeriupredoi commented Oct 2, 2024

thomaskroi1996 commented Oct 3, 2024

valeriupredoi commented Oct 3, 2024

thomaskroi1996 commented Oct 3, 2024

thomaskroi1996 commented Jun 27, 2024 •

edited

Loading

thomaskroi1996 commented Jun 27, 2024 •

edited

Loading

valeriupredoi commented Sep 19, 2024 •

edited

Loading