Add PRIMAVERA Eady Growth Rate diagnostic

[sloosvel]

Description

Recipe and diagnostic script to compute the Eady Growth Rate (PRIMAVERA)

• Closes PRIMAVERA Eddy Growth Rate #256
• 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 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
• 🧪 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

---

[sloosvel]

Some of the models in the recipe require fixes, do I need to open an issue in the core? Or can I directly open a pull request? I already had them collected in a branch.

[bouweandela]

Some of the models in the recipe require fixes, do I need to open an issue in the core? Or can I directly open a pull request? I already had them collected in a branch.

It would be best if you could do both issue and pull request, because that way it is more visible to others that this is 1) a known issue and 2) you are working on it so they don't need to do it.

[stefsmeets]

I think most of the comments have been adressed, not sure how to fix the remaining codacy issues.

• Missing module docstring (missing-module-docstring): The ESMValTool style guide asks us to add a short one line string to the module. Basically add something like this to the top of the file:

"""Diagnostic for PRIMAVERA Eady Growth Rate"""

(make sure to add a blank line after to avoid another style issue)

• Missing class docstring (missing-class-docstring): basically classes also need a docstring, is it missing for EadyGrowthRate?

• Class 'EadyGrowthRate' inherits from object, can be safely removed from bases in python3 : Means that inheriting from object is redundant: class EadyGrowthRate(object): -> class EadyGrowthRate:

• Too many instance attributes (10/7): Feel free to ignore that one 😅

• No blank lines allowed after function docstring (found 1) (D202): Seems to me like the docstring for __init__ has a blank line too many.

[stefsmeets]

Looks good to me! Just some minor formatting suggestions from my side!

Link to documentation: https://esmvaltool--1285.org.readthedocs.build/en/1285/recipes/recipe_eady_growth_rate.html

[bouweandela]

Scientific review-wise, I had people in our department making sure that the results make sense and are actually using them for their own work. Is that enough or would it be better to ask them to comment here?

Once you're done with all the technical work, I think it might be nice ask them to comment (and approve) here, to make it a bit more visible. It would be great if they could try out the new scientific review checklist.

[emchamarro]

Hello,

The description looks fine. I think we could complete it with a reference:

documentation:
  description: |
    Recipe to compute the annual mean or the seasonal mean of the maximum Eady Growth Rate (EGR;
Brian J Hoskins and Paul J Valdes. On the existence of storm-tracks. Journal of the atmospheric sciences, 47(15):1854–1864, 1990.)
   The output produces netcdf files for each model. In the seasonal means, a plot is
    produced for each specified level showing the EGR values over the North-Atlantic region.

The plots look fine, but we could adapt the color scale for values between 0 and 1.1 or so, to see better the signal over the Atlantic. But this is just a suggestion.

I would approve the merge of this recipe.

[sloosvel]

Thank you for the comments @emchamarro! Added the suggestions.

[sloosvel]

@jvegasbsc can you take a look at this, I am not sure why some tests suddenly do not pass. Other than that I would say that everything is ready now?

[jvegreg]

Merge master, I think you need #2022

[sloosvel]

It's already up do date. Do I need to do anything else to get this approved?

[jvegreg]

I got the same issues in other branches, so don't care