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

Recipes without a title do not run #2324

Closed remi-kazeroni closed 3 years ago

remi-kazeroni commented 3 years ago

Recipes without a title can not be run since ESMValGroup/ESMValCore#1332 has been merged.

Running : esmvaltool run examples/recipe_python.yml returns:

Traceback (most recent call last):
  File "/mnt/lustre01/pf/b/b309192/ESMValCore/esmvalcore/_main.py", line 438, in run
    fire.Fire(ESMValTool())
  File "/work/bd0854/b309192/soft/miniconda3/envs/esmvaltool/lib/python3.9/site-packages/fire/core.py", line 141, in Fire
    component_trace = _Fire(component, args, parsed_flag_args, context, name)
  File "/work/bd0854/b309192/soft/miniconda3/envs/esmvaltool/lib/python3.9/site-packages/fire/core.py", line 466, in _Fire
    component, remaining_args = _CallAndUpdateTrace(
  File "/work/bd0854/b309192/soft/miniconda3/envs/esmvaltool/lib/python3.9/site-packages/fire/core.py", line 681, in _CallAndUpdateTrace
    component = fn(*varargs, **kwargs)
  File "/mnt/lustre01/pf/b/b309192/ESMValCore/esmvalcore/_main.py", line 415, in run
    process_recipe(recipe_file=recipe, config_user=cfg)
  File "/mnt/lustre01/pf/b/b309192/ESMValCore/esmvalcore/_main.py", line 101, in process_recipe
    recipe = read_recipe_file(recipe_file, config_user)
  File "/mnt/lustre01/pf/b/b309192/ESMValCore/esmvalcore/_recipe.py", line 61, in read_recipe_file
    check.recipe_with_schema(filename)
  File "/mnt/lustre01/pf/b/b309192/ESMValCore/esmvalcore/_recipe_checks.py", line 63, in recipe_with_schema
    yamale.validate(schema, recipe, strict=False)
  File "/work/bd0854/b309192/soft/miniconda3/envs/esmvaltool/lib/python3.9/site-packages/yamale/yamale.py", line 43, in validate
    raise YamaleError(results)
yamale.yamale_error.YamaleError: Error validating data '/mnt/lustre01/pf/b/b309192/ESMValTool/esmvaltool/recipes/examples/recipe_python.yml' with schema '/mnt/lustre01/pf/b/b309192/ESMValCore/esmvalcore/recipe_schema.yml'
        documentation.title: Required field missing

I'm using the latest versions of the Tool and the Core which I reinstalled. Am I understanding correctly that any recipe without a title cannot be run because of this check? Note that no recipe in the examples directory has a title, so it seems that none can be run at the moment.

Please attach

bouweandela commented 3 years ago

Yes, this is correct, see discussion in ESMValGroup/ESMValCore#1319. We will need to add the titles from the documentation before making the release. Would it be OK to transfer this issue to ESMValTool?

remi-kazeroni commented 3 years ago

Yes, this is correct, see discussion in ESMValGroup/ESMValCore#1319. We will need to add the titles from the documentation before making the release. Would it be OK to transfer this issue to ESMValTool?

Ok thanks for the explanations. I didn't not realize this change would happen so quickly. Adding titles to recipes would also be useful to test the release candidate for the Core.

bouweandela commented 3 years ago

@ESMValGroup/esmvaltool-recipe-maintainers Please add a title to the documentation section of your recipes. This is required for the upcoming release. For most recipes the title can simply be copied from the recipe documentation.

If you would like the output in the generated index.html page look even nicer, it is also possible to add a title and description to each diagnostic. See here for more information.

remi-kazeroni commented 3 years ago

Do we rather expect one PR per recipe / maintainer or one global PR for all recipes? I think it would be helpful to keep track of all the changes either here or in a global PR to make sure we don't release recipes without a tile.

bouweandela commented 3 years ago

I think it is fine to make one pull request for multiple recipes (for example, one per maintainer), but I would not recommend making a single pull request for all recipes. Some recipes may not have documentation and then it may take some time to figure out what the correct titles and descriptions should be.

axel-lauer commented 3 years ago

Just opened a PR to add titles to all recipes maintained by myself: #2332

valeriupredoi commented 3 years ago

and I too am jumping on the wagon with https://github.com/ESMValGroup/ESMValTool/pull/2333

valeriupredoi commented 3 years ago

here is a list of recipes that still need titles as per main at 1130H BST Zulu on 22 October 2021 (55 buggers):

valeriupredoi commented 3 years ago

can I be a bother and ask recipe maintainers from @ESMValGroup/esmvaltool-developmentteam to have a look at the list above and add titles to their recipes and put a link to the PR where they've added titles against each of the now titled recipes please? It'd be good if we did this sooner than later since the 2.4 release is impending, otherwise @zklaus will be knocking on your door :fist_oncoming: :grin:

zklaus commented 3 years ago

Resolved

Recipe Maintainers Resolving PR
recipe_anav13jclim.yml Schlund, Manuel; Wenzel, Sabrina; Anav, Alessandro #2367
recipe_collins13ipcc.yml Senftleben, Daniel; Lorenz, Ruth #2379
recipe_consecdrydays.yml Unknown #2378
recipe_cox18nature.yml Schlund, Manuel #2377
recipe_cvdp.yml Phillips, Adam #2369
recipe_ecs.yml Schlund, Manuel #2377
recipe_ecs_constraints.yml Schlund, Manuel #2377
recipe_extreme_events.yml von Hardenberg, Jost; Mohr, Christian Wilhelm; Arnone, Enrico; Sandstad, Marit #2369
recipe_eyring13jgr_12.yml Cionni, Irene #2366
recipe_hyint_extreme_events.yml von Hardenberg, Jost; Mohr, Christian Wilhelm; Arnone, Enrico; Sandstad, Marit #2369
recipe_landcover.yml Stacke, Tobias; Hagemann, Stefan #2367
recipe_meehl20sciadv.yml Schlund, Manuel #2377
recipe_ocean_Landschuetzer2016.yml Lovato, Tomas #2375
recipe_ocean_amoc.yml de Mora, Lee #2364
recipe_ocean_bgc.yml de Mora, Lee ~#2364~ #2372
recipe_ocean_example.yml de Mora, Lee ~#2364~ #2372
recipe_ocean_ice_extent.yml de Mora, Lee ~#2364~ #2372
recipe_ocean_multimap.yml Lovato, Tomas #2375
recipe_ocean_quadmap.yml de Mora, Lee ~#2364~ #2372
recipe_ocean_scalar_fields.yml de Mora, Lee ~#2364~ #2372
recipe_perfmetrics_CMIP5.yml Frank, Franziska #2367
recipe_perfmetrics_CMIP5_4cds.yml Frank, Franziska #2367
recipe_perfmetrics_land_CMIP5.yml Frank, Franziska; Gier, Bettina #2367
recipe_schlund20esd.yml Schlund, Manuel #2377
recipe_shapeselect.yml Unknown #2378
recipe_spei.yml Unknown #2378
recipe_tcr.yml Schlund, Manuel #2377
recipe_thermodyn_diagtool.yml Koldunov, Nikolay; Lembo, Valerio #2365
recipe_wenzel14jgr.yml Wenzel, Sabrina #2366
recipe_wenzel16jclim.yml Schlund, Manuel; Wenzel, Sabrina #2366
recipe_wenzel16nat.yml Wenzel, Sabrina #2366
recipe_zmnam.yml von Hardenberg, Jost; Serva, Federico; Arnone, Enrico; Cagnazzo, Chiara #2363
schlund20jgr/recipe_schlund20jgr_gpp_abs_rcp85.yml Schlund, Manuel #2377
schlund20jgr/recipe_schlund20jgr_gpp_change_1pct.yml Schlund, Manuel #2377
schlund20jgr/recipe_schlund20jgr_gpp_change_rcp85.yml Schlund, Manuel #2377
recipe_toymodel.yml Bellprat, Omar #2381
cmorizers/recipe_era5-land.yml Weigel, Katja #2382
recipe_deangelis15nat.yml Weigel, Katja #2382
recipe_li17natcc.yml Weigel, Katja #2382
recipe_martin18grl.yml Adeniyi, Kemisola; Weigel, Katja #2382
recipe_pv_capacity_factor.yml Cionni, Irene #2382
recipe_albedolandcover.yml Crezee, Bas; Lejeune, Quentin #2383
recipe_arctic_ocean.yml Koldunov, Nikolay #2383
recipe_carvalhais14nat.yml Koirala, Sujan #2383
recipe_runoff_et.yml Stacke, Tobias; Hagemann, Stefan #2383
recipe_russell18jgr.yml Russell, Joellen; Pandde, Amarjiit #2383
recipe_ensclus.yml von Hardenberg, Jost; Mavilia, Irene; Arnone, Enrico; Corti, Susanna #2384
recipe_hyint.yml von Hardenberg, Jost; Arnone, Enrico #2384
recipe_miles_block.yml von Hardenberg, Jost; Arnone, Enrico; Davini, Paolo #2384
recipe_miles_eof.yml von Hardenberg, Jost; Arnone, Enrico; Davini, Paolo #2384
recipe_miles_regimes.yml von Hardenberg, Jost; Arnone, Enrico; Davini, Paolo #2384
recipe_quantilebias.yml von Hardenberg, Jost; Arnone, Enrico #2384
recipe_rainfarm.yml von Hardenberg, Jost; Arnone, Enrico #2384
cmorizers/recipe_daily_era5.yml Andela, Bouwe; Kalverla, Peter; Alidoost, Sarah #2386
recipe_gier2020bg.yml Gier, Bettina #2386

PRs

ValerioLembo commented 3 years ago

@valeriupredoi @zklaus There you go: #2365

valeriupredoi commented 3 years ago

@valeriupredoi @zklaus There you go: #2365

cheers Valerio! Merged already :)

bouweandela commented 3 years ago

It looks like not all people listed above are a member of the @ESMValGroup/esmvaltool-recipe-maintainers group. If you are a recipe maintainer, please join this group so you do not miss important information.

schlunma commented 3 years ago

Just added a PR for the recipes maintained by myself (#2377).

ruthlorenz commented 3 years ago

I am on maternity leave, do not think I will manage, sorry

zklaus commented 3 years ago

@fserva, could you possibly have a look at the recipes listed under @jhardenberg as well?

valeriupredoi commented 3 years ago

I am on maternity leave, do not think I will manage, sorry

@ruthlorenz not a worry, say hello to the wee baby for us! Maybe if you could write the titles you think are best for your recipes here, then I will plug them in the recipes and open a PR :+1:

zklaus commented 3 years ago

All done, thanks for all the help everyone!

valeriupredoi commented 3 years ago

woohoo big thanks from me too N x :beer: