Autoassess recipes documentation

[bouweandela]

We have the following Autoassess recipes available in ESMValTool:

• recipe_autoassess_landsurface_permafrost.yml
• recipe_autoassess_landsurface_snow.yml
• recipe_autoassess_landsurface_soilmoisture.yml
• recipe_autoassess_landsurface_surfrad.yml
• recipe_autoassess_radiation_rms_Amon_all.yml
• recipe_autoassess_radiation_rms_Amon_obs.yml
• recipe_autoassess_radiation_rms_cfMon_all.yml
• recipe_autoassess_stratosphere.yml

It looks like the only available documentation lives here, which seems to describe the last recipe in the list. Unfortunately, this documentation does not follow the standard we have for recipe documentation, so critical information such as the name of the recipes and diagnostics that it describes is missing.

@valeriupredoi Is there more documentation available? Or does the available documentation describe all recipes?

[valeriupredoi]

@bouweandela the only autoassess recipes that need to be included in the release are:

• recipe_autoassess_radiation_rms_Amon_all.yml
• recipe_autoassess_radiation_rms_Amon_obs.yml
• recipe_autoassess_radiation_rms_cfMon_all.yml
• recipe_autoassess_stratosphere.yml

since the others have not been reviewed yet. The stratosphere one has documentation prepared by @alistairsellar and I would feel uncomfortable changing since he's the scientific expert - I would however add whatever item is missing - which ones items are missing? For the others (the radiation ones) I am unable to provide documentation because I didnt do anything about them apart from porting from v1 to v2 (yeh, lots of code written but I dont know the science) - can anyone help? We can port the documentation from v1 for them I guess 🍺

[bouweandela]

It would be a great start if you could make sure that there is documentation for each recipe and that it follows the template, that would mostly be technical work. I assigned you to this issue, because you're listed as the maintainer. If you feel that other people would be more suited for supplying actual content, can you please ask them to provide it?

the only autoassess recipes that need to be included in the release are ... since the others have not been reviewed yet

This is not good, the recipes that are not ready should not have been merged, because now they are included in the release. Maybe it would be best to make a pull request to remove them and then create new pull requests to add them again and only merge those once they are actually ready for publication?

[valeriupredoi]

This is not good, the recipes that are not ready should not have been merged, because now they are included in the release. Maybe it would be best to make a pull request to remove them and then create new pull requests to add them again and only merge those once they are actually ready for publication?

Yup, that's called for. My apologias for ignoring these - I was always hopeful we could fix them and review them before the release. @alistairsellar and myself will work on a branch, I will move them there in a jiffy 👍

[alistairsellar]

Thanks for flagging, and apologies for not following up at the time. Here's an response for each of the above recipes...

These ones all now have documentation (links added for each):

• recipe_autoassess_landsurface_permafrost.yml (https://docs.esmvaltool.org/en/latest/recipes/recipe_autoassess_landsurface_permafrost.html)
• recipe_autoassess_landsurface_soilmoisture.yml (https://docs.esmvaltool.org/en/latest/recipes/recipe_autoassess_landsurface_soilmoisture.html)
• recipe_autoassess_landsurface_surfrad.yml (https://docs.esmvaltool.org/en/latest/recipes/recipe_autoassess_landsurface_surfrad.html)
• recipe_autoassess_stratosphere.yml (https://docs.esmvaltool.org/en/latest/recipes/recipe_autoassess_stratosphere.html)

There was some confusion around this one in that it went into main by mistake, and was pulled when this was spotted. Subsequent testing found a problem whereby the variables it needed don't exist in CMIP, so it never made it into ESMValTool

• recipe_autoassess_landsurface_snow.yml

That leaves these as the only AutoAssess recipes in main that don't have documentation:

• recipe_autoassess_radiation_rms_Amon_all.yml
• recipe_autoassess_radiation_rms_Amon_obs.yml
• recipe_autoassess_radiation_rms_cfMon_all.yml

I think these were originally added to V1 by Simon Read as a plumbing demonstration, and then subsequently ported to V2 by @valeriupredoi . On inspecting the detail of the recipes, I think that they have been superseded by the more comprehensive "radiation budget" recipe added by Jon Lillis & Emma Hogan last year: https://docs.esmvaltool.org/en/latest/recipes/recipe_radiation_budget.html
So I would propose to remove the above three V1 legacy recipes (recipe_autoassess_radiation_rms_Amon_*.yml). @bouweandela, @valeriupredoi would you be happy for me to open a PR to do that? (would assign to myself)

[alistairsellar]

Apologies for not spotting the superseding at the time - should have proposed this removal at that point. As in, apologies for not saving the effort that went into #2990 and any other maintenance tasks for these superseded recipes.

[valeriupredoi]

Brilliant, cheers muchly @alistairsellar - let's nuke them! I can open a PR tommz, or you can, either way let's remove them by 2.8 o'clock 🍺

[bouweandela]

recipe_autoassess_stratosphere.yml (https://docs.esmvaltool.org/en/latest/recipes/recipe_autoassess_stratosphere.html)

I could not find the name of the recipe on this documentation page. And is Mattia still a current contact for obtaining the required data?

[alistairsellar]

Brilliant, cheers muchly @alistairsellar - let's nuke them! I can open a PR tommz, or you can, either way let's remove them by 2.8 o'clock 🍺

I'll open a PR today @valeriupredoi

[alistairsellar]

recipe_autoassess_stratosphere.yml (https://docs.esmvaltool.org/en/latest/recipes/recipe_autoassess_stratosphere.html)

I could not find the name of the recipe on this documentation page. And is Mattia still a current contact for obtaining the required data?

Thanks Bouwe, I will add the name of the recipe.

@valeriupredoi, can you advise me regarding Bouwe's point about the data? Presumably these obs datasets are in the data pool so we don't need this kind of statement at all?

[remi-kazeroni]

Thanks @alistairsellar! If the obs datasets used are part of our list of supported datasets, you do not need to add any contact point information. Such datasets are available at DKRZ, to a large extend at Jasmin, and in all cases our CMORizers contain some documentation on how to manually download the raw data.

[valeriupredoi]

cheers much @alistairsellar - about the OBSes - what @remi-kazeroni says, and they are all "publicly" available at DKRZ and JASMIN 👍