Add Hovmoeller MJO diagnostic

[JurijSchoenfeld]

Description

Evaluating atmospheric patterns like the MJO, is important to assess the performance of an ESM. Applications of this diagnostic include but are not limitted to evaluation of different convective parameterizations. The diagnostic adds a standard metric to diagnose MJO, which is not straight forward to compute, involving a (slightly) tricky filter operation.

• Closes MJO with Hovmöller plot #4563
• Link to documentation: https://esmvaltool--4564.org.readthedocs.build/en/4564/recipes/recipe_mjo_hovmoeller.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

---

To help with the number of pull requests:

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

Compare to Figure 9 in Hannah et al. 2020 (https://doi.org/10.1029/2019MS001863)

[CLAassistant]

All committers have signed the CLA.

[schlunma]

Thanks @ApexCapybara @JurijSchoenfeld (copy-paste fail 🤦 ), looks great already! Just a couple of comments to make the code simpler. It would be great if you could add documentation to the recipe/diagnostic (e.g., like done in #3155).

If you want, you can also add your name to the CITATION.cff and .zenodo.json to become an official contributor.

Thanks 🚀

[JurijSchoenfeld]

Hi @schlunma I pushed my commits containing all your feedback. I also resolved most of commit autoreview comments except the code style warnings from Codacy that I find a bit pedantic. Please let me know if you have further questions or need me to change anything :)

[schlunma]

Thanks @JurijSchoenfeld, that's great! I added a couple of commits with automatic fixes, which got rid of almost all Codacy warnings.

The only thing that's missing is a little bit of documentation. You could take a look at #4561 and do it the same way (focus on the files in doc/sphinx/source/). You can more or less copy-paste the information from the docstring of your diagnostic to an *.rst file in the docs. That would be great, thanks so much!!

[JurijSchoenfeld]

Hi @schlunma, I added some documentation and used the template.rst file as a reference. Let me know if you need further changes

[schlunma]

Fantastic, thanks so much @JurijSchoenfeld! It might make sense to generalize the docs within #3995 once this is ready for review, but for now this looks good to me!

@ESMValGroup/atmosphere would anyone be able to do a quick science review of this? On the surface this looks good to me, but I am certainly no expert on this topic. Thanks so much!

Example output is available here: https://swift.dkrz.de/v1/dkrz_4eefb34f-8803-415a-bd70-9c455db9a403/esmvaltool_output/mjo_jurij/index.html

[LisaBock]

Thanks @JurijSchoenfeld !
Looks mostly fine to me. I have only two small comments.

[LisaBock]

Maybe you can write here "mm day-1" as units in the brackets. We use this typically for precipitation.

[LisaBock]

It would be useful if you would be able to set vmax also in the recipe. This enables an easier comparison between model and observation.