Add recipe and diagnostic scripts to compute figures of D9.4 of ISENES3

[sloosvel]

This pull request adds a new example recipe and diagnostic script that compares the global average of tas for DCPP data with an observational dataset. It exemplifies the use of the new timerange tag.

Description

• Closes Add recipe with examples using decadal data #2440
• Link to documentation:

---

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 --> Many example recipes are not listed in the documentation. Is this an issue?
• 🛠 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

[schlunma]

@sloosvel Release v2.5 is approaching quickly (the feature freeze will be on 2022-02-21). Since this pull request is marked for v2.5, could you briefly comment if you further intend to include this in the new release and/or if you are facing any problems with it? Thanks!!

[remi-kazeroni]

I will proceed with the review shortly and would like to have this in v2.5. Shall I wait for the next release candidate @schlunma?

@sloosvel, would you have the possibility to check the failing test and Codacy issues and also edit the checklist? Thanks!

[schlunma]

Shall I wait for the next release candidate @schlunma?

Yes, that might be a good idea. I will do this as soon as ESMValGroup/ESMValCore#1486 is merged.

[sloosvel]

I'll push the codacy fixes tomorrow, the rest of the tests are failing because timerange is still not recognised as a valid time tag and the tool is expecting start_year and end_year instead.

[remi-kazeroni]

Thanks a lot for creating this recipe and this diagnostic @sloosvel! I ran the recipe successfully on Mistral at the first attempt. I used the v2.5-rc2 for the Core. Everything looks fine: provenance is recorded, plots are identical to the IS-ENES3 deliverable D9.4, a filled copy of the recipe is created without the wildcards. My only question would be: do you want to add an entry to the documentation page for this recipe and maybe add some information and/or a plot to the documentation?

[sloosvel]

Thanks for the review @remi-kazeroni ! I adressed the comments but tests are failing now:

Invalid value encountered for timerange. Valid value must follow ISO 8601 standard for dates and duration periods, or be set to '*' to load available years. Got ['0000', '9999'] instead.

It looks like years 0000 and 9999 from the test dataset cannot be parsed. I can update the test to have dates that can be parsed but is this something that should be fixed in the core as well? How likely is it to run into these kind of dates in real data?

[zklaus]

In normal calendars, there is no year zero. Additionally, CF uses year 0 to indicate climatologies in some cases (see CF Conventions 1.9, Section 4.4.1), so this really should not appear in time range selection. I think that year 9999 is probably no problem.

[sloosvel]

Fixed! Is there something going on with the documentation build? It failed in another pull request as well and for the same reason that in this one.

[zklaus]

Is there something going on with the documentation build?

This was fixed in #2531. Merging main will solve it here too.

[remi-kazeroni]

Thanks for making the changes @sloosvel! Everything looks good to me. This PR is all green and ready to be merged imho.