search

ESMValGroup / ESMValTool

ESMValTool: A community diagnostic and performance metrics tool for routine evaluation of Earth system models in CMIP
https://www.esmvaltool.org
Apache License 2.0
224 stars 128 forks source link

Approximate radiative forcing perturbation diagnosis #1304

Open znicholls opened 5 years ago

znicholls commented 5 years ago

Short description of the diagnostic

Calculation of radiative fluxes based on the Approximate Radiative Perturbation method (Taylor et al., 2007, https://journals.ametsoc.org/doi/pdf/10.1175/JCLI4143.1). This would bring the work done in https://github.com/chrisroadmap/climateforcing/blob/master/aprp/aprp.py by @chrisroadmap to the ESMValTool.

Branch and pull request

TBD

znicholls commented 5 years ago

Thanks again for everyone involved in the ESMValTool for your huge efforts!!

If anyone is able to give me a hand with this that would be much appreciated. I'll have lots of questions I suspect. As a (hopefully) easy first question, which branch should I branch off? (I'm guessing not master as it's not default).

bouweandela commented 5 years ago

Hi Zeb,

Great that you're interested in contributing to ESMValTool!

We have a very short guide on contributing available here in CONTRIBUTING.md and more detailed information in the diagnostic developer guide on readthedocs. Unfortunately the latter is not yet in very good shape, it contains a lot of useful information, but it's not very well structured and there's probably essential bits missing.

For now, I'd highly recommend you simply start by copy/pasting the example recipe and associated the example diagnostic script, try to get it running and then start adjusting that until it does what you need.

As a (hopefully) easy first question, which branch should I branch off? (I'm guessing not master as it's not default).

Use version2_development, we have an open issue about improving this #1174.

znicholls commented 5 years ago

Awesome thanks @bouweandela ! I'm happy to add whatever seems useful to the docs as I go along. I'm guessing you'd want the PRs split before reviewing them (i.e. separate doc updates from extra diagnostic from whatever else)?

Thanks for the advice, I managed to get the ecs diagnosis recipe running so think I should be able to work it out from there.

bouweandela commented 5 years ago

I'm guessing you'd want the PRs split before reviewing them (i.e. separate doc updates from extra diagnostic from whatever else)?

We're trying to keep the documentation synchronized with the code, so if you add a new recipe and diagnostic, please also add a documentation page in doc/sphinx/source/recipes/