# ESMValTool
# recipe_perfmetrics_land_CMIP5.yml
---
documentation:
  title: Performance metrics for land variables in CMIP5

  description: |
    Recipe for plotting the performance metrics for the CMIP5 datasets,
    including only land variables

  authors:
    - gier_bettina
    - winterstein_franziska
    - righi_mattia
    - eyring_veronika

  maintainer:
    - righi_mattia

  references:
    - gleckler08jgr

  projects:
    - esmval
    - embrace
    - crescendo
    - c3s-magic
    - cmug

preprocessors:

  ppNOLEV1:
    regrid:
      target_grid: reference_dataset
      scheme: linear
    mask_fillvalues:
      threshold_fraction: 0.95
    multi_model_statistics:
      span: overlap
      statistics: [mean, median]
      exclude: [reference_dataset]

  ppNOLEV2:
    regrid:
      target_grid: reference_dataset
      scheme: linear
    mask_fillvalues:
      threshold_fraction: 0.95
    multi_model_statistics:
      span: overlap
      statistics: [mean, median]
      exclude: [reference_dataset, alternative_dataset]


diagnostics:

  sm:
    description: Soil moisture
    themes:
      - phys
    realms:
      - land
    variables:
      sm:
        short_name: sm
        preprocessor: ppNOLEV1
        reference_dataset: ESACCI-SOILMOISTURE
        mip: Lmon
        derive: true
        force_derivation: false
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: ACCESS1-0}
      - {dataset: ACCESS1-3}
      - {dataset: bcc-csm1-1}
      - {dataset: CanCM4}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CESM1-BGC}
      - {dataset: CESM1-CAM5}
      - {dataset: CESM1-FASTCHEM}
      - {dataset: CESM1-WACCM}
      - {dataset: CNRM-CM5}
      - {dataset: CSIRO-Mk3-6-0}
      - {dataset: FGOALS-g2}
      - {dataset: FGOALS-s2}
      - {dataset: GFDL-CM3}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: HadCM3}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC4h}
      - {dataset: MIROC5}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MRI-CGCM3}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}

      - {dataset: ESACCI-SOILMOISTURE, project: OBS, type: sat,
         version: L3S-SSMV-COMBINED-v4.2, tier: 2, start_year: 1980}
    scripts:
      grading: &grading_settings
        script: perfmetrics/main.ncl
        # Plot type ('cycle', 'zonal', 'latlon', 'cycle_latlon', 'cycle_zonal')
        plot_type: cycle_latlon
        # Time average ('opt' argument of time_operations.ncl)
        time_avg: monthlyclim
        # Region ('global', 'trop', 'nhext', 'shext')
        region: global
        # Plot standard deviation ('all', 'none', 'ref_model' or dataset name)
        plot_stddev: ref_model
        # Plot legend in a separate file
        legend_outside: true
        # Plot style
        styleset: CMIP5
        # Calculate grading
        calc_grading: true
        # Metric ('RMSD', 'BIAS', taylor')
        metric: [RMSD]
        # Normalization ('mean', 'median', 'centered_median', 'none')
        normalization: [centered_median]


  nbp:
    description: surface_net_downward_mass_flux_of_carbon_dioxide_expressed_as_carbon_due_to_all_land_processes
    themes:
      - phys
    realms:
      - land
    variables:
      nbp:
        short_name: nbp
        preprocessor: ppNOLEV1
        reference_dataset: JMA-TRANSCOM
        mip: Lmon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: BNU-ESM}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CESM1-BGC}
      - {dataset: CESM1-FASTCHEM}
      - {dataset: CESM1-WACCM, ensemble: r2i1p1}
      - {dataset: CMCC-CESM}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: HadGEM2-CC}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: MRI-ESM1}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}

      - {dataset: JMA-TRANSCOM, project: OBS, type: reanaly,
         version: 2018, tier: 3, start_year: 1985}
    scripts:
      grading:
        <<: *grading_settings


  gpp:
    description: Carbon Mass Flux out of Atmosphere due to Gross Primary
    themes:
      - phys
    realms:
      - land
    variables:
      gpp:
        short_name: gpp
        preprocessor: ppNOLEV2
        reference_dataset: MTE
        alternative_dataset: FLUXCOM
        mip: Lmon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: bcc-csm1-1}
      - {dataset: bcc-csm1-1-m}
      - {dataset: BNU-ESM}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CESM1-BGC}
      - {dataset: CESM1-CAM5}
      - {dataset: CESM1-FASTCHEM}
      - {dataset: CESM1-WACCM, ensemble: r2i1p1}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: HadCM3}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}

      - {dataset: FLUXCOM, project: OBS, type: reanaly,
         version: ANN-v1, tier: 3}
      - {dataset: MTE, project: OBS, type: reanaly,
         version: May12, tier: 3, start_year: 1982}
    scripts:
      grading:
        <<: *grading_settings


  lai:
    description: Leaf Area Index
    themes:
      - phys
    realms:
      - land
    variables:
      lai:
        short_name: lai
        preprocessor: ppNOLEV1
        reference_dataset: LAI3g
        mip: Lmon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: ACCESS1-0}
      - {dataset: ACCESS1-3}
      - {dataset: bcc-csm1-1}
      - {dataset: bcc-csm1-1-m}
      - {dataset: BNU-ESM}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CESM1-BGC}
      - {dataset: CESM1-CAM5}
      - {dataset: CESM1-FASTCHEM}
      - {dataset: CESM1-WACCM, ensemble: r2i1p1}
      - {dataset: FIO-ESM}
      - {dataset: GFDL-CM3}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC4h}
      - {dataset: MIROC5}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}

      - {dataset: LAI3g, project: OBS, type: reanaly,
         version: 1_regridded, tier: 3, start_year: 1981}
    scripts:
      grading:
        <<: *grading_settings


  fgco2:
    description: surface_downward_mass_flux_of_carbon_dioxide_expressed_as_carbon
    themes:
      - phys
    realms:
      - ocnBgchem
    variables:
      fgco2:
        short_name: fgco2
        preprocessor: ppNOLEV2
        reference_dataset: JMA-TRANSCOM
        alternative_dataset: Landschuetzer2016
        mip: Omon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      #- {dataset: BNU-ESM} # data is missing on ESGF
      - {dataset: CanESM2}
      - {dataset: CESM1-BGC}
      - {dataset: CMCC-CESM}
      - {dataset: CNRM-CM5}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: GISS-E2-H-CC}
      - {dataset: GISS-E2-R-CC}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MRI-ESM1}
      - {dataset: NorESM1-ME}

      - {dataset: JMA-TRANSCOM, project: OBS, type: reanaly,
         version: 2018, tier: 3, start_year: 1985}
      - {dataset: Landschuetzer2016, project: OBS, type: clim,
         version: v2016, tier: 2, start_year: 1982}
    scripts:
      grading:
        <<: *grading_settings


  et:
    description: total_evapotranspiration
    themes:
      - phys
    realms:
      - land
    variables:
      et:
        short_name: et
        preprocessor: ppNOLEV1
        reference_dataset: LandFlux-EVAL
        mip: Lmon
        derive: true
        force_derivation: false
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: ACCESS1-0}
      - {dataset: ACCESS1-3}
      - {dataset: bcc-csm1-1}
      - {dataset: bcc-csm1-1-m}
      - {dataset: CanCM4}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CESM1-BGC}
      - {dataset: CESM1-CAM5}
      - {dataset: CESM1-FASTCHEM}
      - {dataset: CESM1-WACCM}
      - {dataset: CMCC-CESM}
      - {dataset: CMCC-CMS}
      - {dataset: CNRM-CM5}
      - {dataset: CSIRO-Mk3-6-0}
      - {dataset: EC-EARTH, ensemble: r2i1p1}
      - {dataset: FGOALS-g2}
      - {dataset: FGOALS-s2}
      - {dataset: GFDL-CM3}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: GISS-E2-H, ensemble: r1i1p2}
      - {dataset: GISS-E2-H-CC}
      - {dataset: GISS-E2-R, ensemble: r1i1p2}
      - {dataset: GISS-E2-R-CC}
      - {dataset: HadCM3}
      - {dataset: HadGEM2-AO}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC4h}
      - {dataset: MIROC5}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: MRI-CGCM3}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}

      - {dataset: LandFlux-EVAL, project: OBS, type: reanaly,
         version: Oct13, tier: 3, start_year: 1990}
    scripts:
      grading:
        <<: *grading_settings


  rlus:
    description: surface upwelling longwave flux in air
    themes:
      - phys
    realms:
      - atmos
    variables:
      rlus:
        short_name: rlus
        preprocessor: ppNOLEV1
        reference_dataset: CERES-EBAF_Surface
        mip: Amon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: ACCESS1-0}
      - {dataset: bcc-csm1-1}
      - {dataset: CanCM4}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CNRM-CM5}
      - {dataset: CSIRO-Mk3-6-0}
      - {dataset: FGOALS-g2}
      - {dataset: FGOALS-s2}
      - {dataset: GFDL-CM2p1}
      - {dataset: GFDL-CM3}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: GISS-E2-H, ensemble: r1i1p2}
      - {dataset: GISS-E2-R, ensemble: r1i1p2}
      - {dataset: HadCM3}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC4h}
      - {dataset: MIROC5}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: MRI-CGCM3}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}
      - {dataset: CERES-EBAF_Surface, project: obs4MIPs, level: L3B, tier: 1, start_year: 2001, end_year: 2013}
    scripts:
      grading:
        <<: *grading_settings


  rlds:
    description: surface_downwelling_longwave_flux_in_air
    themes:
      - phys
    realms:
      - atmos
    variables:
      rlds:
        short_name: rlds
        preprocessor: ppNOLEV1
        reference_dataset: CERES-EBAF_Surface
        mip: Amon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: ACCESS1-0}
      - {dataset: ACCESS1-3}
      - {dataset: bcc-csm1-1}
      - {dataset: CanCM4}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CNRM-CM5}
      - {dataset: CSIRO-Mk3-6-0}
      - {dataset: FGOALS-g2}
      - {dataset: FGOALS-s2}
      - {dataset: GFDL-CM2p1}
      - {dataset: GFDL-CM3}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: GISS-E2-H, ensemble: r1i1p2}
      - {dataset: GISS-E2-R, ensemble: r1i1p2}
      - {dataset: HadCM3}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC4h}
      - {dataset: MIROC5}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: MRI-CGCM3}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}
      - {dataset: CERES-EBAF_Surface, project: obs4MIPs, level: L3B, tier: 1, start_year: 2001, end_year: 2013}
    scripts:
      grading:
        <<: *grading_settings


  rsus:
    description: surface_upwelling_shortwave_flux_in_air
    themes:
      - phys
    realms:
      - atmos
    variables:
      rsus:
        short_name: rsus
        preprocessor: ppNOLEV1
        reference_dataset: CERES-EBAF_Surface
        mip: Amon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: ACCESS1-0}
      - {dataset: bcc-csm1-1}
      - {dataset: CanCM4}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CNRM-CM5}
      - {dataset: CSIRO-Mk3-6-0}
      - {dataset: FGOALS-g2}
      - {dataset: FGOALS-s2}
      - {dataset: GFDL-CM2p1}
      - {dataset: GFDL-CM3}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: GISS-E2-H, ensemble: r1i1p2}
      - {dataset: GISS-E2-R, ensemble: r1i1p2}
      - {dataset: HadCM3}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC4h}
      - {dataset: MIROC5}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: MRI-CGCM3}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}
      - {dataset: CERES-EBAF_Surface, project: obs4MIPs, level: L3B, tier: 1, start_year: 2001, end_year: 2013}
    scripts:
      grading:
        <<: *grading_settings


  rsds:
    description: surface_downwelling_shortwave_flux_in_air
    themes:
      - phys
    realms:
      - atmos
    variables:
      rsds:
        short_name: rsds
        preprocessor: ppNOLEV1
        reference_dataset: CERES-EBAF_Surface
        mip: Amon
        project: CMIP5
        exp: historical
        ensemble: r1i1p1
        start_year: 1980
        end_year: 1999
    additional_datasets:
      - {dataset: ACCESS1-0}
      - {dataset: ACCESS1-3}
      - {dataset: bcc-csm1-1}
      - {dataset: CanCM4}
      - {dataset: CanESM2}
      - {dataset: CCSM4}
      - {dataset: CNRM-CM5}
      - {dataset: CSIRO-Mk3-6-0}
      - {dataset: FGOALS-g2}
      - {dataset: FGOALS-s2}
      - {dataset: GFDL-CM2p1}
      - {dataset: GFDL-CM3}
      - {dataset: GFDL-ESM2G}
      - {dataset: GFDL-ESM2M}
      - {dataset: GISS-E2-H, ensemble: r1i1p2}
      - {dataset: GISS-E2-R, ensemble: r1i1p2}
      - {dataset: HadCM3}
      - {dataset: HadGEM2-CC}
      - {dataset: HadGEM2-ES}
      - {dataset: inmcm4}
      - {dataset: IPSL-CM5A-LR}
      - {dataset: IPSL-CM5A-MR}
      - {dataset: IPSL-CM5B-LR}
      - {dataset: MIROC4h}
      - {dataset: MIROC5}
      - {dataset: MIROC-ESM}
      - {dataset: MIROC-ESM-CHEM}
      - {dataset: MPI-ESM-LR}
      - {dataset: MPI-ESM-MR}
      - {dataset: MPI-ESM-P}
      - {dataset: MRI-CGCM3}
      - {dataset: NorESM1-M}
      - {dataset: NorESM1-ME}

      - {dataset: CERES-EBAF_Surface, project: obs4MIPs, level: L3B, tier: 1, start_year: 2001, end_year: 2013}
    scripts:
      grading:
        <<: *grading_settings


  ### COLLECT METRICS #########################################################
  collect:
    description: Wrapper to collect and plot previously calculated metrics
    scripts:
      RMSD:
        script: perfmetrics/collect.ncl
        ancestors: ['*/grading*']
        metric: RMSD
        label_bounds: [-0.5, 0.5]
        label_scale: 0.1
        disp_values: false
        cm_interval: [2, 241]
        # Sort dataset in alphabetic order (excluding MMM)
        sort: true
        diag_order: ['sm-global', 'nbp-global', 'lai-global', 'gpp-global',
                     'fgco2-global', 'et-global',
                     'rsds-global', 'rsus-global', 'rlds-global', 'rlus-global']