Radiation budget: labelling plots with alias by NParsonsMO · Pull Request #4292 · ESMValGroup/ESMValTool

NParsonsMO · 2025-12-17T15:01:10Z

Changing the f-strings in the plot titles to use a dataset's alias instead of its name.

Closes Amend radiation budget slightly to label plots with an alias #4291
Link to documentation: https://esmvaltool--4292.org.readthedocs.build/en/4292/recipes/recipe_radiation_budget.html

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

To help with the number of pull requests:

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

NParsonsMO · 2025-12-17T15:21:57Z

Output before change:

NParsonsMO · 2025-12-17T15:29:41Z

Output after change:

NParsonsMO · 2025-12-17T15:47:03Z

@ehogan I'm not sure if I should change the picture in the documentation? Or mention alias in there somewhere?

valeriupredoi · 2025-12-17T16:23:10Z

@ehogan yet again GH notifies me of a PR that's being created by a MO bod, though I'm neither assigned nor requested as a reviewer - heck, am not even of an owner of the code that's being changed; I noticed this previously with your guys' work on RTW, do you folks at the MO have a config setting that says "ping V everytime we open a PR"? 🤣

ehogan · 2025-12-17T17:36:20Z

@ehogan yet again GH notifies me of a PR that's being created by a MO bod, though I'm neither assigned nor requested as a reviewer - heck, am not even of an owner of the code that's being changed; I noticed this previously with your guys' work on RTW, do you folks at the MO have a config setting that says "ping V everytime we open a PR"? 🤣

🤣 Not to my knowledge! 🤪 I can't see why you would have been notified?! 🤯

ehogan

Thanks @NParsonsMO 🥳

ehogan · 2026-03-16T15:05:56Z

@ehogan I'm not sure if I should change the picture in the documentation? Or mention alias in there somewhere?

Good question. I wonder whether it's worth adding something to ESMValTool documentation: Radiation Budget: User settings in recipe to mention that alias can be added to the dataset? The only documentation I can find about what should be in this section is in the template, and it doesn't mention "settings for dataset" but hopefully it's ok to add something about that here? 🤔

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

NParsonsMO · 2026-03-20T10:38:38Z

@ehogan I'm not sure if I should change the picture in the documentation? Or mention alias in there somewhere?

Good question. I wonder whether it's worth adding something to ESMValTool documentation: Radiation Budget: User settings in recipe to mention that alias can be added to the dataset? The only documentation I can find about what should be in this section is in the template, and it doesn't mention "settings for dataset" but hopefully it's ok to add something about that here? 🤔

I put it in "User settings in recipe".

e172b65

ehogan

Thanks @NParsonsMO! 🥳

ehogan · 2026-06-16T10:34:31Z

+
+.. code-block:: yaml
+
+    {dataset: HadGEM3-GC31-LL, alias: HadGEM3-GC3.1 N96ORCA1, project: ... }


Does this work with the white space? 😮

Also, while we are here, would it be possible to remove the indentation from the bullet list items above (L25, L29 and L30) so that the documentation renders correctly, please? 😊

Does this work with the white space? 😮

Also, while we are here, would it be possible to remove the indentation from the bullet list items above (L25, L29 and L30) so that the documentation renders correctly, please? 😊

063394b

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

Amending plot f-strings

5885188

NParsonsMO self-assigned this Dec 17, 2025

NParsonsMO linked an issue Dec 17, 2025 that may be closed by this pull request

Amend radiation budget slightly to label plots with an alias #4291

Open

NParsonsMO added 2 commits December 17, 2025 15:09

Retry, in the right folder?!

e70fa29

Switch to double quotes

8ebc7e7

NParsonsMO changed the title ~~Amending plot f-strings~~ Radiation budget: labelling plots with alias Dec 17, 2025

accidental rename

0595c1a

NParsonsMO requested a review from ehogan December 17, 2025 15:34

NParsonsMO mentioned this pull request Dec 17, 2025

Amend radiation budget recipe and diagnostic script on ESMValTool MetOffice/CMEW#302

Open

NParsonsMO marked this pull request as ready for review January 5, 2026 08:10

ehogan requested changes Mar 16, 2026

View reviewed changes

Comment thread esmvaltool/diag_scripts/radiation_budget/radiation_budget.py Outdated

Comment thread esmvaltool/diag_scripts/radiation_budget/radiation_budget.py Outdated

Comment thread esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

NParsonsMO and others added 6 commits March 20, 2026 09:47

Accepting suggestion

04cc201

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

Removing model_dataset from plot_data function

03c1812

Alphabetising and adding parameter description

d35f17c

Adding aliases equal to datasets

b7e7b8e

Adding in-code comment about model period assumption

1feb6ba

Adding alias to documentation

e172b65

Merge branch 'main' into 4291-amend-radiation-budget-to-use-alias

650a6c1

NParsonsMO requested a review from ehogan March 20, 2026 10:54

Merge branch 'main' into 4291-amend-radiation-budget-to-use-alias

19507b5

ehogan requested changes Jun 16, 2026

View reviewed changes

NParsonsMO and others added 2 commits June 16, 2026 11:48

Update esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

3d0989c

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

Update esmvaltool/diag_scripts/radiation_budget/radiation_budget.py

9c23962

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

Removed indentation

063394b

NParsonsMO requested a review from ehogan June 16, 2026 11:28

Merge branch 'main' into 4291-amend-radiation-budget-to-use-alias

2bf88cd


		.. code-block:: yaml

		{dataset: HadGEM3-GC31-LL, alias: HadGEM3-GC3.1 N96ORCA1, project: ... }

Conversation

NParsonsMO commented Dec 17, 2025 • edited by ehogan Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changing the f-strings in the plot titles to use a dataset's alias instead of its name.

Before you get started

Checklist

New or updated recipe/diagnostic

New or updated data reformatting script

Uh oh!

NParsonsMO commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NParsonsMO commented Dec 17, 2025

Uh oh!

NParsonsMO commented Dec 17, 2025

Uh oh!

valeriupredoi commented Dec 17, 2025

Uh oh!

ehogan commented Dec 17, 2025

Uh oh!

ehogan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ehogan commented Mar 16, 2026

Uh oh!

NParsonsMO commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ehogan left a comment

Choose a reason for hiding this comment

Uh oh!

ehogan Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

ehogan Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

NParsonsMO Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

NParsonsMO Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

NParsonsMO commented Dec 17, 2025 •

edited by ehogan

Loading

NParsonsMO commented Dec 17, 2025 •

edited

Loading

NParsonsMO commented Mar 20, 2026 •

edited

Loading