Add a realistic example recipe

esmvaltool/diag_scripts/examples/make_plot.py

@@ -0,0 +1,76 @@
+"""Python example diagnostic."""
+import logging
+from pathlib import Path
+
+import iris
+import matplotlib.pyplot as plt
+
+from esmvaltool.diag_scripts.shared import run_diagnostic, save_figure
+
+logger = logging.getLogger(Path(__file__).stem)
+
+
+def main(cfg):
+    """Plot part of figure_9.3a from IPCC AR6."""
+    colors = {
+        'historical-ssp126': '#2a3652',
+        'historical-ssp585': '#78333a',
+    }
+    fill_colors = {
+        'historical-ssp126': '#d2d5dc',
+        'historical-ssp585': '#ddced2',
+    }
+    labels = {
+        'historical-ssp126': 'Historical and SSP1-2.6',
+        'historical-ssp585': 'Historical and SSP5-8.5',
+    }
+
+    # Group input data by experiment
+    groups = {}
+    for filename, attributes in cfg['input_data'].items():
+        exp = attributes['exp']
+        if exp not in groups:
+            groups[exp] = {}
+        groups[exp][attributes['dataset']] = filename
+
+    # Loop over experiments to populate plot
+    for exp, group in groups.items():
+        mean = iris.load_cube(group['MultiModelMean'])
+        iris.quickplot.plot(
+            mean,
+            color=colors.get(exp),
+            label=labels.get(exp, exp),
+        )
+
+        p17 = iris.load_cube(group['MultiModelP17'])
+        p83 = iris.load_cube(group['MultiModelP83'])
+        time_coord = mean.coord('time')
+        time_axis = time_coord.units.num2date(time_coord.core_points())
+        plt.fill_between(
+            time_axis,
+            p17.core_data(),
+            p83.core_data(),
+            color=fill_colors.get(exp),
+            label='Likely (17% - 83%) ranges',
+        )
+
+    plt.title('Sea surface temperature anomaly')
+    plt.legend(loc='upper left')
+
+    filename = 'IPCC_AR6_figure_9.3a_1850-2100'
+    provenance_record = {
+        'caption': "Part of figure 9.3a from IPCC AR6.",
+        'authors': [
+            'kalverla_peter',
+            'andela_bouwe',
+        ],
+        'references': ['fox-kemper21ipcc'],
+        'ancestors': list(cfg['input_data'].keys()),
+    }
+    save_figure(filename, provenance_record, cfg, dpi=300)
+
+
+if __name__ == '__main__':
+
+    with run_diagnostic() as config:
+        main(config)

esmvaltool/recipes/examples/recipe_easy_ipcc.yml

@@ -0,0 +1,126 @@
+documentation:
+  title: Easy IPCC
+  description: Reproduce part of IPCC AR6 figure 9.3a.
+  references:
+    - fox-kemper21ipcc
+  authors:
+    - kalverla_peter
+    - andela_bouwe
+  maintainer:
+    - unmaintained
+
+preprocessors:
+  easy_ipcc:
+    custom_order: true
+    anomalies:
+      period: month
+      reference:
+        start_year: 1950
+        start_month: 1
+        start_day: 1
+        end_year: 1979
+        end_month: 12
+        end_day: 31
+    area_statistics:
+      operator: mean
+    annual_statistics:
+      operator: mean
+    convert_units:
+      units: 'degrees_C'
+    ensemble_statistics:
+      statistics:
+        - mean
+    multi_model_statistics:
+      statistics:
+        - mean
+        - p17
+        - p83
+      span: full
+      keep_input_datasets: false
+      ignore_scalar_coords: true
+
+diagnostics:
+  AR6_Figure_9.3:
+    variables:
+      tos_ssp585:
+        short_name: tos
+        exp: ['historical', 'ssp585']
+        project: CMIP6
+        mip: Omon
+        preprocessor: easy_ipcc
+        timerange: '1850/2100'
+      tos_ssp126:
+        short_name: tos
+        exp: ['historical', 'ssp126']
+        project: CMIP6
+        mip: Omon
+        timerange: '1850/2100'
+        preprocessor: easy_ipcc
+    scripts:
+      Figure_9.3a:
+        script: examples/make_plot.py
+
+datasets:
+  - {dataset: ACCESS-CM2, ensemble: 'r(1:5)i1p1f1', grid: gn}
+  - {dataset: ACCESS-ESM1-5, ensemble: 'r(1:40)i1p1f1', grid: gn}
+  - {dataset: AWI-CM-1-1-MR, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: BCC-CSM2-MR, ensemble: r1i1p1f1, grid: gn}
+  # - {dataset: CAMS-CSM1-0, ensemble: 'r(1:2)i1p1f1', grid: gn} # available data does not cover timerange
+  - {dataset: CAS-ESM2-0, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: CAS-ESM2-0, ensemble: r3i1p1f1, grid: gn}
+  - {dataset: CESM2, ensemble: r4i1p1f1, grid: gn}
+  - {dataset: CESM2, ensemble: 'r(10:11)i1p1f1', grid: gn}
+  - {dataset: CESM2-WACCM, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: CIESM, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: CMCC-CM2-SR5, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: CMCC-ESM2, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: CNRM-CM6-1, ensemble: 'r(1:6)i1p1f2', grid: gn}
+  - {dataset: CNRM-CM6-1-HR, ensemble: r1i1p1f2, grid: gn}
+  - {dataset: CNRM-ESM2-1, ensemble: 'r(1:5)i1p1f2', grid: gn}
+  - {dataset: CanESM5, ensemble: 'r(1:25)i1p(1:2)f1', grid: gn}
+  - {dataset: CanESM5-1, ensemble: 'r1i1p(1:2)f1', grid: gn, institute: CCCma}
+  - {dataset: CanESM5-CanOE, ensemble: 'r(1:3)i1p2f1', grid: gn}
+  - {dataset: EC-Earth3, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: EC-Earth3, ensemble: r4i1p1f1, grid: gn}
+  - {dataset: EC-Earth3, ensemble: r6i1p1f1, grid: gn}
+  # - {dataset: EC-Earth3, ensemble: r9i1p1f1, grid: gn}  # download failure of ssp585
+  - {dataset: EC-Earth3, ensemble: r11i1p1f1, grid: gn}
+  - {dataset: EC-Earth3, ensemble: r15i1p1f1, grid: gn}
+  # - {dataset: EC-Earth3, ensemble: 'r(101:150)i1p1f1', grid: gn}  # available data does not cover timerange
+  - {dataset: EC-Earth3-Veg, ensemble: 'r(1:4)i1p1f1', grid: gn}
+  - {dataset: EC-Earth3-Veg, ensemble: r6i1p1f1, grid: gn}
+  # - {dataset: EC-Earth3-Veg-LR, ensemble: 'r(1:3)i1p1f1', grid: gn}  # mismatch between i and j coordinate names between historical and ssp experiment
+  - {dataset: FGOALS-f3-L, ensemble: 'r(1:3)i1p1f1', grid: gn}
+  - {dataset: FGOALS-g3, ensemble: 'r(1:4)i1p1f1', grid: gn}
+  - {dataset: FIO-ESM-2-0, ensemble: 'r(1:3)i1p1f1', grid: gn}
+  - {dataset: GFDL-ESM4, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: GISS-E2-1-G, ensemble: 'r(1:4)i1p5f1', grid: gn, supplementary_variables: [{short_name: areacella, mip: fx, exp: piControl, ensemble: r1i1p5f1}, {short_name: areacello, skip: true}]}
+  - {dataset: GISS-E2-1-G, ensemble: 'r(1:5)i1p1f2', grid: gn, supplementary_variables: [{short_name: areacella, mip: fx, exp: piControl, ensemble: r1i1p1f1}, {short_name: areacello, skip: true}]}
+  - {dataset: GISS-E2-1-G, ensemble: 'r(1:5)i1p3f1', grid: gn, supplementary_variables: [{short_name: areacella, mip: fx, exp: piControl, ensemble: r1i1p3f1}, {short_name: areacello, skip: true}]}
+  - {dataset: GISS-E2-1-H, ensemble: 'r(1:5)i1p1f2', grid: gn, supplementary_variables: [{short_name: areacella, mip: fx, exp: piControl, ensemble: r1i1p1f1}, {short_name: areacello, skip: true}]}
+  - {dataset: GISS-E2-1-H, ensemble: 'r(1:5)i1p3f1', grid: gn, supplementary_variables: [{short_name: areacella, mip: fx, exp: piControl, ensemble: r1i1p3f1}, {short_name: areacello, skip: true}]}
+  - {dataset: GISS-E2-2-G, ensemble: 'r(1:5)i1p3f1', grid: gn, supplementary_variables: [{short_name: areacella, mip: fx, exp: piControl, ensemble: r1i1p1f1}, {short_name: areacello, skip: true}]}
+  - {dataset: HadGEM3-GC31-LL, ensemble: r1i1p1f3, grid: gn}
+  - {dataset: HadGEM3-GC31-MM, ensemble: r1i1p1f3, grid: gn}
+  # - {dataset: IITM-ESM, ensemble: r1i1p1f1, grid: gn}  # available data does not cover timerange
+  - {dataset: INM-CM4-8, ensemble: r1i1p1f1, grid: gr1}
+  - {dataset: INM-CM5-0, ensemble: r1i1p1f1, grid: gr1}
+  - {dataset: IPSL-CM6A-LR, ensemble: 'r(1:4)i1p1f1', grid: gn}
+  - {dataset: IPSL-CM6A-LR, ensemble: r6i1p1f1, grid: gn}
+  - {dataset: IPSL-CM6A-LR, ensemble: r14i1p1f1, grid: gn}
+  # - {dataset: KACE-1-0-G, ensemble: 'r(1:3)i1p1f1', grid: gr}  # unstructured grid but no cell area information available
+  # - {dataset: KIOST-ESM, ensemble: r1i1p1f1, grid: gr1}  # historical and ssp126 experiment are on different grids
+  - {dataset: MCM-UA-1-0, ensemble: r1i1p1f2, grid: gn}
+  - {dataset: MIROC-ES2H, ensemble: r1i1p4f2, grid: gn}
+  - {dataset: MIROC-ES2L, ensemble: 'r(1:10)i1p1f2', grid: gn}
+  - {dataset: MIROC6, ensemble: 'r(1:50)i1p1f1', grid: gn}
+  - {dataset: MPI-ESM1-2-HR, ensemble: 'r1i1p1f1', grid: gn}
+  # - {dataset: MPI-ESM1-2-HR, ensemble: 'r(1:2)i1p1f1', grid: gn}  # second ensemble member causes warnings about large graphs in `concatenate` preprocessor step
+  - {dataset: MPI-ESM1-2-LR, ensemble: 'r(1:30)i1p1f1', grid: gn}
+  - {dataset: MRI-ESM2-0, ensemble: 'r(1:5)i1p1f1', grid: gn}
+  # - {dataset: NESM3, ensemble: 'r(1:2)i1p1f1', grid: gn}  # cannot be used due to https://github.com/ESMValGroup/ESMValCore/issues/2101
+  # - {dataset: NorESM2-LM, ensemble: r1i1p1f1, grid: gn}  # duplicated areacello file with wrong name
+  - {dataset: NorESM2-MM, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: TaiESM1, ensemble: r1i1p1f1, grid: gn}
+  - {dataset: UKESM1-0-LL, ensemble: 'r(1:4)i1p1f2', grid: gn}
+  - {dataset: UKESM1-0-LL, ensemble: r8i1p1f2, grid: gn}

esmvaltool/references/fox-kemper21ipcc.bibtex

@@ -0,0 +1,11 @@
+@inbook{fox-kemper21ipcc,
+  author={B. Fox-Kemper and H.T. Hewitt and C. Xiao and G. Aðalgeirsdóttir and S.S. Drijfhout and T.L. Edwards and N.R. Golledge and M. Hemer and R.E. Kopp and G. Krinner and A. Mix and D. Notz and S. Nowicki and I.S. Nurhati and L. Ruiz and J.-B. Sallée and A.B.A. Slangen and Y. Yu},
+  editor={V. Masson-Delmotte and P. Zhai and A. Pirani and S.L. Connors and C. Pean and S. Berger and N. Caud and Y. Chen and L. Goldfarb and M.I. Gomis and M. Huang and K. Leitzell and E. Lonnoy and J.B.R. Matthews and T.K. Maycock and T. Waterfield and O. Yelekci and R. Yu and B. Zhou},
+  title={Ocean, Cryosphere and Sea Level Change},
+  booktitle={Climate Change 2021: The Physical Science Basis. Contribution of Working Group I to the Sixth Assessment Report of the Intergovernmental Panel on Climate Change},
+  year={2021},
+  publisher={Cambridge University Press},
+  address={Cambridge, UK and New York, NY, USA},
+  pages = {1211--1362},
+  doi={10.1017/9781009157896.011}
+}