Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cleanup recipe headers before the release #1740

Merged
merged 8 commits into from Jul 22, 2020
Merged

Cleanup recipe headers before the release #1740

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5989fd5
Clean recipe headers
mattiarighi Jul 20, 2020
a97edff
Rename to filenaming standard
mattiarighi Jul 20, 2020
c77bcae
Update esmvaltool/recipes/recipe_albedolandcover.yml
mattiarighi Jul 20, 2020
85da37e
Merge branch 'master' into recipe_cleanup
mattiarighi Jul 22, 2020
3efb42f
Fix reference tag
mattiarighi Jul 22, 2020
574345f
Update esmvaltool/recipes/recipe_albedolandcover.yml
mattiarighi Jul 22, 2020
145fa05
Fix reference tag
mattiarighi Jul 22, 2020
8dbac41
Merge branch 'recipe_cleanup' of https://github.com/ESMValGroup/ESMVa…
mattiarighi Jul 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
0 ...gures/droughtindex/martin2018grl_fig1.png → ...figures/droughtindex/martin18grl_fig1.png
View file
Open in desktop
File renamed without changes
0 ...gures/droughtindex/martin2018grl_fig2.png → ...figures/droughtindex/martin18grl_fig2.png
View file
Open in desktop
File renamed without changes
2 changes: 1 addition & 1 deletion doc/sphinx/source/recipes/index.rst
View file
Open in desktop
Expand Up @@ -25,7 +25,7 @@ Atmosphere
recipe_modes_of_variability
recipe_quantilebias
recipe_spei
recipe_martin2018grl
recipe_martin18grl
recipe_autoassess_stratosphere
recipe_zmnam
recipe_thermodyn_diagtool
Expand Down
12 changes: 6 additions & 6 deletions ...x/source/recipes/recipe_martin2018grl.rst → ...inx/source/recipes/recipe_martin18grl.rst
View file
Open in desktop
@@ -1,4 +1,4 @@
.. _recipes_martin2018grl:
.. _recipes_martin18grl:

Drought characteristics following Martin (2018)
===============================================
Expand All @@ -18,7 +18,7 @@ Available recipes and diagnostics

Recipes are stored in recipes/

* recipe_martin2018grl.yml
* recipe_martin18grl.yml


Diagnostics are stored in diag_scripts/
Expand Down Expand Up @@ -75,15 +75,15 @@ References
Example plots
-------------

.. _martin2018grl_fig1:
.. figure:: /recipes/figures/droughtindex/martin2018grl_fig1.png
.. _martin18grl_fig1:
.. figure:: /recipes/figures/droughtindex/martin18grl_fig1.png
:align: center
:width: 50%

Global map of the percentage difference between multi-model mean of 15 CMIP models and the CRU data for the number of drought events [%] based on SPI.

.. _martin2018grl_fig2:
.. figure:: /recipes/figures/droughtindex/martin2018grl_fig2.png
.. _martin18grl_fig2:
.. figure:: /recipes/figures/droughtindex/martin18grl_fig2.png
:align: center
:width: 50%

Expand Down
14 changes: 7 additions & 7 deletions esmvaltool/diag_scripts/droughtindex/collect_drought_func.py
View file
Open in desktop
Expand Up @@ -81,11 +81,11 @@ def _provenance_map_spei(cfg, name_dict, spei, dataset_name):
'based on ' + cfg['indexname'] + '.'

if cfg['indexname'].lower == "spei":
set_refs = ['martin2018grl', 'vicente10jclim', ]
set_refs = ['martin18grl', 'vicente10jclim', ]
elif cfg['indexname'].lower == "spi":
set_refs = ['martin2018grl', 'mckee93proc', ]
set_refs = ['martin18grl', 'mckee93proc', ]
else:
set_refs = ['martin2018grl', ]
set_refs = ['martin18grl', ]

provenance_record = get_provenance_record([name_dict['input_filenames']],
caption,
Expand Down Expand Up @@ -116,11 +116,11 @@ def _provenance_map_spei_multi(cfg, data_dict, spei, input_filenames):
'based on ' + cfg['indexname'] + '.'

if cfg['indexname'].lower == "spei":
set_refs = ['martin2018grl', 'vicente10jclim', ]
set_refs = ['martin18grl', 'vicente10jclim', ]
elif cfg['indexname'].lower == "spi":
set_refs = ['martin2018grl', 'mckee93proc', ]
set_refs = ['martin18grl', 'mckee93proc', ]
else:
set_refs = ['martin2018grl', ]
set_refs = ['martin18grl', ]

provenance_record = get_provenance_record(input_filenames, caption,
['global'],
Expand Down Expand Up @@ -151,7 +151,7 @@ def _provenance_time_series_spei(cfg, data_dict):
elif cfg['indexname'].lower == "spi":
set_refs = ['mckee93proc', ]
else:
set_refs = ['martin2018grl', ]
set_refs = ['martin18grl', ]

provenance_record = get_provenance_record([data_dict['filename']],
caption,
Expand Down
3 changes: 2 additions & 1 deletion esmvaltool/recipes/examples/recipe_julia.yml
View file
Open in desktop
Expand Up @@ -2,7 +2,8 @@
# recipe_julia.yml
---
documentation:
description: Recipe for example diagnostic written in Julia.
description: |
Recipe for example diagnostic written in Julia.

authors:
- vonhardenberg_jost
Expand Down
1 change: 1 addition & 0 deletions esmvaltool/recipes/examples/recipe_my_personal_diagnostic.yml
View file
Open in desktop
@@ -1,4 +1,5 @@
# ESMValTool
# recipe_my_personal_diagnostic.yml
---
documentation:
description: |
Expand Down
3 changes: 2 additions & 1 deletion esmvaltool/recipes/examples/recipe_python.yml
View file
Open in desktop
Expand Up @@ -2,7 +2,8 @@
# recipe_python.yml
---
documentation:
description: Example recipe that plots the mean precipitation and temperature.
description: |
Example recipe that plots the mean precipitation and temperature.

authors:
- andela_bouwe
Expand Down
3 changes: 2 additions & 1 deletion esmvaltool/recipes/examples/recipe_r.yml
View file
Open in desktop
Expand Up @@ -2,7 +2,8 @@
# recipe_example_r.yml
---
documentation:
description: Recipe for example diagnostic written in R.
description: |
Recipe for example diagnostic written in R.

authors:
- arnone_enrico
Expand Down
2 changes: 1 addition & 1 deletion esmvaltool/recipes/examples/recipe_variable_groups.yml
View file
Open in desktop
@@ -1,7 +1,7 @@
# ESMValTool
# recipe_variable_groups.yml
---
documentation:

description: |
Example recipe to demonstrate grouping of variables in the diagnostic
section.
Expand Down
12 changes: 9 additions & 3 deletions esmvaltool/recipes/hydrology/recipe_hype.yml
View file
Open in desktop
Expand Up @@ -6,9 +6,15 @@ documentation:
Recipe pre-processes ERA5 and ERA-Interim reanalyses files
for use in the Hype hydrological model.

authors: ['pelupessy_inti', 'kalverla_peter']
projects: ['ewatercycle']
references: ['acknow_project']
authors:
- pelupessy_inti
- kalverla_peter

projects:
- ewatercycle

references:
- acknow_project

preprocessors:
preprocessor: &general
Expand Down
14 changes: 11 additions & 3 deletions esmvaltool/recipes/hydrology/recipe_lisflood.yml
View file
Open in desktop
Expand Up @@ -4,9 +4,17 @@
documentation:
description: |
Recipe pre-process files for use in the LISFLOOD hydrological model.
authors: [verhoeven_stefan, kalverla_peter, andela_bouwe]
projects: [ewatercycle]
references: ['acknow_project']

authors:
- verhoeven_stefan
- kalverla_peter
- andela_bouwe

projects:
- ewatercycle

references:
- acknow_project

datasets:
- {dataset: ERA-Interim, project: OBS6, tier: 3, type: reanaly, version: 1}
Expand Down
14 changes: 11 additions & 3 deletions esmvaltool/recipes/hydrology/recipe_marrmot.yml
View file
Open in desktop
Expand Up @@ -8,9 +8,17 @@ documentation:

MARRMoT is the Modular Assessment of Rainfall-Runnoff Models Toolbox ...
https://www.geosci-model-dev.net/12/2463/2019/
authors: ['kalverla_peter', 'camphuijsen_jaro', 'alidoost_sarah']
projects: ['ewatercycle']
references: ['acknow_project']

authors:
- kalverla_peter
- camphuijsen_jaro
- alidoost_sarah

projects:
- ewatercycle

references:
- acknow_project

preprocessors:
daily: &daily
Expand Down
12 changes: 9 additions & 3 deletions esmvaltool/recipes/hydrology/recipe_pcrglobwb.yml
View file
Open in desktop
Expand Up @@ -2,16 +2,22 @@
# recipe_pcrglobwb.yml
---
documentation:
description: Pre-processes climate data for use in the PCR-GLOBWB hydrological model.
description: |
Pre-processes climate data for use in the PCR-GLOBWB hydrological model.

authors:
- aerts_jerom
- andela_bouwe
- drost_niels
- camphuijsen_jaro
- alidoost_sarah
- kalverla_peter
projects: ['ewatercycle']
references: ['acknow_project', 'sutanudjaja2018gmd']

projects:
- ewatercycle

references:
- sutanudjaja2018gmd
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You lost acknow_project here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Though that is actually not a reference, but a request to acknowledge, so maybe we need to think a bit about how to improve this in the future

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

acknow_project was introduced for cases where no other references were available, which is not case here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's probably never the case, because all our recipes are based on scientific work, right? Only the example recipes wouldn't have references.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually there are 5 recipes without an actual reference: recipe_consecdrydays.yml, recipe_ocean_Landschuetzer2016.yml, recipe_ocean_multimap.yml, recipe_shapeselect.yml and recipe_spei.yml.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe references just need to be added?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe yes, but not all our diagnostics are based on published work, or the paper is not yet ready.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be fine to have no reference if no reference is available.



preprocessors:
Expand Down
12 changes: 9 additions & 3 deletions esmvaltool/recipes/hydrology/recipe_wflow.yml
View file
Open in desktop
Expand Up @@ -2,15 +2,21 @@
# recipe_wflow.yml
---
documentation:
description: Pre-processes climate data for the WFlow hydrological model.
description: |
Pre-processes climate data for the WFlow hydrological model.

authors:
- kalverla_peter
- camphuijsen_jaro
- alidoost_sarah
- aerts_jerom
- andela_bouwe
projects: ['ewatercycle']
references: ['acknow_project']

projects:
- ewatercycle

references:
- acknow_project

preprocessors:
rough_cutout:
Expand Down
6 changes: 4 additions & 2 deletions esmvaltool/recipes/recipe_albedolandcover.yml
View file
Open in desktop
@@ -1,9 +1,11 @@
# ESMValTool

# recipe_albedolandcover.yml
---
documentation:
description: |
analyzes relationship between landcover and albedo in CMIP models
This recipe analyzes the relationship between landcover and albedo
in CMIP models

authors:
- crezee_bas
- lejeune_quentin
Expand Down
2 changes: 1 addition & 1 deletion esmvaltool/recipes/recipe_anav13jclim.yml
View file
Open in desktop
@@ -1,7 +1,7 @@
# ESMValTool
# recipe_anav13jclim.xml
---
documentation:

description: |
This recipe reproduces most of the figures of Anav et al. (2013).

Expand Down
10 changes: 5 additions & 5 deletions esmvaltool/recipes/recipe_collins13ipcc.yml
View file
Open in desktop
@@ -1,5 +1,5 @@
# ESMValTool
# recipe_collins13ipcc.yml

---
documentation:
description: |
Expand All @@ -10,7 +10,7 @@ documentation:
Only a subset of models are included for most examples!
Diagnostic IAV_calc_thetao (zonal ocean temperature, variable thetao) needs
a lot of memory, make sure you have enough memory available to read
piControl runs or exclude!
piControl runs or exclude!

authors:
- lorenz_ruth
Expand Down Expand Up @@ -900,7 +900,7 @@ diagnostics:
# Labels on top of each panel (loop is seasons, scenarios, periods)
label: ["RCP8.5 2081-2100 DJF", "RCP8.5 2181-2200 DJF",
"RCP8.5 2081-2100 MAM", "RCP8.5 2181-2200 MAM",
"RCP8.5 2081-2100 JJA", "RCP8.5 2181-2200 JJA",
"RCP8.5 2081-2100 JJA", "RCP8.5 2181-2200 JJA",
"RCP8.5 2081-2100 SON", "RCP8.5 2181-2200 SON"]

### Optional attributes
Expand Down Expand Up @@ -944,8 +944,8 @@ diagnostics:
# pltname:
# Print number of models at top-right of the figure
model_nr: true


### Mean Total Radiation change in RCPs for multi model mean ###############
IAV_calc_rtmt:
description: Calculate total radiation interannual variability
Expand Down
17 changes: 13 additions & 4 deletions esmvaltool/recipes/recipe_consecdrydays.yml
View file
Open in desktop
@@ -1,9 +1,18 @@
# ESMValTool
# recipe_consecdrydays
---
documentation:
description: 'Consecutive dry days'
authors: ['berg_peter']
projects: ['c3s-magic']
references: ['acknow_project']
description: |
Recipe to calculate consecutive dry days

authors:
- berg_peter

projects:
- c3s-magic

references:
- acknow_project

datasets:
- {dataset: bcc-csm1-1-m, project: CMIP5, mip: day, exp: historical, ensemble: r1i1p1, start_year: 2001, end_year: 2002}
Expand Down
2 changes: 1 addition & 1 deletion esmvaltool/recipes/recipe_cox18nature.yml
View file
Open in desktop
@@ -1,7 +1,7 @@
# ESMValTool
# recipe_cox18nature.yml
---
documentation:

description: |
Reproducing the emergent constraint for ECS based on global temperature
variability (Cox et al., 2018).
Expand Down
1 change: 1 addition & 0 deletions esmvaltool/recipes/recipe_deangelis15nat.yml
View file
Open in desktop
@@ -1,3 +1,4 @@
# ESMValTool
# recipe_deangelis15nat.yml
---
documentation:
Expand Down
2 changes: 1 addition & 1 deletion esmvaltool/recipes/recipe_ecs.yml
View file
Open in desktop
@@ -1,7 +1,7 @@
# ESMValTool
# recipe_ecs.yml
---
documentation:

description: |
Calculate ECS using linear regression following Gregory et al. (2004).

Expand Down
1 change: 1 addition & 0 deletions esmvaltool/recipes/recipe_ecs_scatter.yml
View file
Open in desktop
@@ -1,3 +1,4 @@
# ESMValTool
# recipe_ecs_scatter.yml
---
documentation:
Expand Down
1 change: 1 addition & 0 deletions esmvaltool/recipes/recipe_ensclus.yml
View file
Open in desktop
@@ -1,3 +1,4 @@
# ESMValTool
# recipe_EnsClus.yml
---
documentation:
Expand Down
4 changes: 2 additions & 2 deletions esmvaltool/recipes/recipe_eyring06jgr.yml
View file
Open in desktop
Expand Up @@ -2,16 +2,16 @@
# recipe_eyring06jgr.yml
---
documentation:

description: |
Diagnostics of stratospheric dynamics and chemistry reproducing selected
figures from Eyring et al. JGR (2006).

authors:
- cionni_irene
- hassler_birgit

maintainer:
- cionni_irene
- hassler_birgit

references:
- eyring06jgr
Expand Down
3 changes: 1 addition & 2 deletions esmvaltool/recipes/recipe_flato13ipcc.yml
View file
Open in desktop
Expand Up @@ -2,7 +2,6 @@
# recipe_flato13ipcc.yml
---
documentation:

description: |
Reproducing selected figures from IPCC AR5, chap. 9 (Flato et al., 2013)
9.2, 9.4, 9.5, 9.6, 9.8, 9.14, 9.24, 9.26, 9.27, 9.42, 9.45a.
Expand All @@ -19,7 +18,7 @@ documentation:
- zimmermann_klaus

maintainer:
- righi_mattia
- lauer_axel

references:
- flato13ipcc
Expand Down
2 changes: 1 addition & 1 deletion esmvaltool/recipes/recipe_hyint.yml
View file
Open in desktop
@@ -1,6 +1,6 @@
# ESMValTool
# recipe_hyint.yml
---

documentation:
description: |
Recipe for the HyInt package by E. Arnone and J. von Hardenberg (ISAC-CNR)
Expand Down