Add hydrological forcing comparison recipe

[stefsmeets]

Description

Hi everyone, this recipe compares between ERA5, ERA-interim, and MSWEP datasets for a certain catchment.

• Closes #issue_number
• Link to documentation: https://esmvaltool--2013.org.readthedocs.build/en/2013/recipes/recipe_hydro_forcing.html

Todo:

• Bugfix: Fix units for MSWEP data ESMValCore#986 merged

---

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 PR is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.

• 🛠 PR has a descriptive title for the changelog
• 🛠 Code follows the style guide
• 🛠 Documentation is available
• 🛠 YAML files pass pre-commit or yamllint checks
• 🛠 Circle/CI tests pass
• 🛠 Codacy code quality checks pass
• 🛠 Documentation builds successfully on readthedocs

New or updated recipe/diagnostic:

• 🛠 Provenance information has been added
• 🛠 New dependencies are added to the project requirements
• 🧪 Documentation for the recipe/diagnostic clearly describes what it calculates from a scientific point of view
• 🧪 Recipe runs successfully on @esmvalbot or some other machine without modification (MSWEP data not available)
• 🧪 Figure(s)/data look as expected
• 🧪 Code is well documented and scientifically sound

---

To help with the number pull requests:

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

[stefsmeets]

Hi @Peter9192 , I think this PR is ready. Could you do a technical review?

[jvegreg]

I can test it if you want, but I will need a suitable shapefile

[stefsmeets]

I can test it if you want, but I will need a suitable shapefile

@jvegasbsc That would be great! I'm using the shapefiles from here: https://github.com/eWaterCycle/recipes_auxiliary_datasets/tree/master/Lorentz_Basin_Shapefiles

You will also need the MSWEP data: https://docs.esmvaltool.org/projects/ESMValCore/en/latest/develop/fixing_data.html?highlight=mswep#mswep
(or just run with ERA5 / ERA-Interim)

[jvegreg]

Thanks. I've just run it for ERA-Interim, as we only have monthly data for ERA5 in jasmin

[jvegreg]

The code itself looks good and clean. Good work, @stefsmeets

[stefsmeets]

Thanks @jvegasbsc , I have updated the code. I think it is better now 👍

[stefsmeets]

Hi @jeromaerts , could you do a scientific review of this recipe? Especially, could you have a look at the documentation, descriptions, captions, etc., whether they make sense scientifically?

[jeromaerts]

@stefsmeets, Looks great, also from a scientific point of view.

Some small notes on the documentation:

• "3. Plot the monthly climate statistics over a certain period"
  Change: "3. Plot the monthly climatology statistics over a certain period"

If possible extent the plotting of climatology to also include a daily climatology plot.

• "All hydrological recipes require a shapefile as an input to produce forcing data."
  Change, produce to select.

• "All recipes are tested with the shapefiles that are used for the eWaterCycle project."
  "All recipes are tested with shapefiles from HydroSHEDS that are used for the eWaterCycle project."

Looking at the figures, the dates on the horizontal axis are very close to each other, perhaps slightly reduce the label font-size.

[stefsmeets]

Hi @jeromaerts , thanks for the comments! I have updated the code and added the new plot. Let me know what you think. If you are happy with the changes, could you approve the PR?

[jeromaerts]

The docs are updated and consistent with hydrology conventions.

[stefsmeets]

Hi @jvegasbsc , have you had a chance to take another look at the changes I made? If you agree, could you approve this PR so we can get this merged? If you have any other comments, please let me know!

[stefsmeets]

ping @jvegasbsc 😁

[jvegreg]

Looks better now! I agree with @nielsdrost comment about tha nimng of the entry_point but that's a very minor concern.

And sorry for the delay, I went straight to holidays after the release

[stefsmeets]

Looks better now! I agree with @nielsdrost comment about tha nimng of the entry_point but that's a very minor concern.

And sorry for the delay, I went straight to holidays after the release

No worries, probably well-deserved! 😅 Will fix it next week 👍

[nielsdrost]

Thanks @stefsmeets !