AutoAssess: Add new diagnostic for radiation budget #2282

Jon-Lillis · 2021-09-03T15:23:48Z

Description

Closes AutoAssess: Add new diagnostic for radiation budget #2209
Link to documentation: https://esmvaltool--2282.org.readthedocs.build/en/2282/

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

To help with the number of pull requests:

🙏 We kindly ask you to review two other open pull requests in this repository

…ostic module

Jon-Lillis · 2021-09-03T15:46:56Z

@esmvalbot Please run recipe_radiation_budget.yml

esmvalbot · 2021-09-03T15:46:58Z

Since @Jon-Lillis asked, ESMValBot will run recipe recipe_radiation_budget.yml as soon as possible, output will be generated here

esmvalbot · 2021-09-03T16:13:15Z

ESMValBot is sorry to report it failed to run recipe recipe_radiation_budget.yml: exit is 1, output has been generated here

…ing indentation'

…ption'

Jon-Lillis · 2021-10-20T09:33:33Z

Moved plots to issue #2209.

valeriupredoi

all good from me, cheers and good work, guys! All we need now is a sciencey reviewer - @alistairsellar when you gots some time, mate 🍺

alistairsellar

I'm happy from a science perspective. The values in the plots attached to #2209 appear identical to the eye, and the metrics in the csv files differ by less than 0.75%, and only 0.06% on average. The science parts of the code look to be doing the right thing.

#2209 notes that there are some variables missing in the CERES files in the data pool and that this will be picked up in a later issue. Fine by me - please open that issue now so we don't lose sight of the gap.

esmvaltool/diag_scripts/radiation_budget/common.py

esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

esmvaltool/diag_scripts/radiation_budget/seasonal_radiation_budget.py

… function

ehogan

Thanks everyone!

I believe the only outstanding issues (not related to any of my comments) is the general principle on whether diagnostics should fail or warn when inputs are missing.

esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

doc/sphinx/source/recipes/recipe_radiation_budget.rst

esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

ehogan · 2021-11-23T08:27:15Z

esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

+def get_provenance_record(filenames):
+    """Return a provenance record describing the plot.
+
+    Parameters
+    ----------
+    filenames : list of strings
+        The filenames containing the data used to create the plot.
+
+    Returns
+    -------
+    dictionary
+        The provenance record describing the plot.
+    """
+    record = {
+        'ancestors': filenames,
+    }
+    return record


We added a bare minimum provenance record. This is all we needed to add for the recipe to run without errors. The tutorial has a very short "Recording the provenance" section, which links to the ESMValTool documentation, but we weren't sure on the best practice here. Is there anything else that we should add here? Would it be worth adding more details to the tutorial about this?

esmvaltool/recipes/recipe_radiation_budget.yml

Co-authored-by: Emma Hogan <ehogan@users.noreply.github.com>

ehogan

Thanks for making those changes, @Jon-Lillis! :)

ehogan · 2021-12-02T09:52:13Z

@valeriupredoi I think this PR is ready to be merged 🎉 Is there anything else we need to do before this happens?

valeriupredoi · 2021-12-02T16:55:10Z

awesome job here, guys! 🍺

valeriupredoi · 2021-12-02T16:56:52Z

one last question, from @alistairsellar

#2209 notes that there are some variables missing in the CERES files in the data pool and that this will be picked up in a later issue. Fine by me - please open that issue now so we don't lose sight of the gap.

Has this been opened? 🍺

Jon-Lillis · 2021-12-03T10:09:53Z

Yep, this was opened in #2428. I've modified the description to include adding the additional variables to the radiation budget diagnostic.

valeriupredoi · 2021-12-03T11:34:29Z

excellent, cheers @Jon-Lillis 🍺

Jon-Lillis added 11 commits June 29, 2021 10:24

Add new author to config-references.yml

7413151

Create skeleton recipe and diagnostic

d122f67

Add datasets section and variables to recipe, add load_cubes to diagn…

2f4576b

…ostic module

Added climate_statistic preprocessor

bc6bd54

Added area_statistics preprocessor

57ccdcb

Group data by model.

1580440

Derive and organise variables.

08955df

Load and validate observational data.

5fb758f

Validate the model data.

2dcb873

Added plot function.

3bef0ca

Add CERES data.

37b30ea

Jon-Lillis self-assigned this Sep 3, 2021

Jon-Lillis added 13 commits September 6, 2021 10:28

0a0a840

Address Codacy 'Variable name "ax" doesn't conform to pattern'

082b20c

Address Codacy 'Do not use len(SEQUENCE) without comparison'

19ce951

Address Codacy 'missing function or method docstring' and 'wrong hang…

7169a28

…ing indentation'

Address Codacy 'Use lazy % formatting in logging functions'

8013c96

Address Codacy 'Missing module docstring'

1ee8a80

Address Codacy '1 blank line required between summary line and descri…

d0c2310

…ption'

Removed TODO.

56d58e3

Merge branch 'main' into radiation_budget_new_diagnostic

48fcd0d

Tidy of recipe and diagnostic

bfa1dca

Added seasonal radiation budget diagnostic

0e898c0

Add @ehogan to authors file

3b30801

Refactor plotting code

14e5eb5

Jon-Lillis requested a review from alistairsellar October 15, 2021 15:54

valeriupredoi approved these changes Nov 17, 2021

View reviewed changes

Replaced private function with ESMValCore helper function

5ab92b1

alistairsellar approved these changes Nov 17, 2021

View reviewed changes

valeriupredoi added approved by technical reviewer and removed in technical review labels Nov 17, 2021

alistairsellar added approved by scientific reviewer and removed in scientific review labels Nov 17, 2021

Jon-Lillis added 4 commits November 17, 2021 16:15

Added more detail to documentation overview

86a1447

Updated the recipe description to match the docs

77796bd

Converted txt observation files into yml format and modified the read…

17426e7

… function

Removed mentions of specific models from docstrings

232fa53

ehogan requested changes Nov 23, 2021

View reviewed changes

Jon-Lillis and others added 6 commits November 23, 2021 10:54

Update esmvaltool/recipes/recipe_radiation_budget.yml

029694e

Co-authored-by: Emma Hogan <ehogan@users.noreply.github.com>

Update esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

879fb16

Co-authored-by: Emma Hogan <ehogan@users.noreply.github.com>

Update doc/sphinx/source/recipes/recipe_radiation_budget.rst

6767ac4

Co-authored-by: Emma Hogan <ehogan@users.noreply.github.com>

Update doc/sphinx/source/recipes/recipe_radiation_budget.rst

22e201a

Co-authored-by: Emma Hogan <ehogan@users.noreply.github.com>

Update doc/sphinx/source/recipes/recipe_radiation_budget.rst

d77a756

Co-authored-by: Emma Hogan <ehogan@users.noreply.github.com>

Update esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

fb64aa8

Co-authored-by: Emma Hogan <ehogan@users.noreply.github.com>

ehogan approved these changes Dec 2, 2021

View reviewed changes

valeriupredoi merged commit ce6092c into main Dec 2, 2021

valeriupredoi deleted the radiation_budget_new_diagnostic branch December 2, 2021 16:55

ehogan added the AutoAssess Issues relevant to the conversion of AutoAssess metrics from Met Office to ESMValTool label Dec 10, 2021

ehogan changed the title ~~Radiation budget new diagnostic~~ AutoAssess: Add new diagnostic for radiation budget Dec 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AutoAssess: Add new diagnostic for radiation budget #2282

AutoAssess: Add new diagnostic for radiation budget #2282

Jon-Lillis commented Sep 3, 2021 •

edited

Loading

Jon-Lillis commented Sep 3, 2021

esmvalbot bot commented Sep 3, 2021

esmvalbot bot commented Sep 3, 2021

Jon-Lillis commented Oct 20, 2021 •

edited

Loading

valeriupredoi left a comment

alistairsellar left a comment

ehogan left a comment

ehogan Nov 23, 2021

ehogan left a comment

ehogan commented Dec 2, 2021

valeriupredoi commented Dec 2, 2021

valeriupredoi commented Dec 2, 2021

Jon-Lillis commented Dec 3, 2021

valeriupredoi commented Dec 3, 2021

AutoAssess: Add new diagnostic for radiation budget #2282

AutoAssess: Add new diagnostic for radiation budget #2282

Conversation

Jon-Lillis commented Sep 3, 2021 • edited Loading

Description

Before you get started

Checklist

New or updated recipe/diagnostic

Jon-Lillis commented Sep 3, 2021

esmvalbot bot commented Sep 3, 2021

esmvalbot bot commented Sep 3, 2021

Jon-Lillis commented Oct 20, 2021 • edited Loading

valeriupredoi left a comment

Choose a reason for hiding this comment

alistairsellar left a comment

Choose a reason for hiding this comment

ehogan left a comment

Choose a reason for hiding this comment

ehogan Nov 23, 2021

Choose a reason for hiding this comment

ehogan left a comment

Choose a reason for hiding this comment

ehogan commented Dec 2, 2021

valeriupredoi commented Dec 2, 2021

valeriupredoi commented Dec 2, 2021

Jon-Lillis commented Dec 3, 2021

valeriupredoi commented Dec 3, 2021

Jon-Lillis commented Sep 3, 2021 •

edited

Loading

Jon-Lillis commented Oct 20, 2021 •

edited

Loading