# ESMValTool
# recipe_martin18grl.yml
---
documentation:
  title: "Drought characteristics following Martin (2018)"
  description: |
    Calculate the SPI and counting drought events following Martin (2018).
  authors:
    - weigel_katja
    - adeniyi_kemisola

  references:
    - martin18grl

  maintainer:
    - weigel_katja

  projects:
    - eval4cmip

preprocessors:
  preprocessor1:
    regrid:
      target_grid: 2.0x2.0
      scheme: linear
  preprocessor2:
    regrid:
      target_grid: 2.0x2.0
      scheme: linear

diagnostics:
  diagnostic1:
    variables:
      pr:
        reference_dataset: CRU
        preprocessor: preprocessor1
        field: T2Ms
        start_year: 1901
        end_year: 2000
    additional_datasets:
      # - {dataset: ERA-Interim, project: OBS6, mip: Amon, type: reanaly,
      #   version: 1, start_year: 1979, end_year: 2005, tier: 3}
      # - {dataset: MIROC-ESM, project: CMIP5, mip: Amon, exp: historical,
      #    ensemble: r1i1p1, start_year: 1979, end_year: 2005}
      # - {dataset: GFDL-CM3, project: CMIP5, mip: Amon,
      #    exp: historical, ensemble: r1i1p1,
      #    start_year: 1979, end_year: 2005}
      - {dataset: CRU, mip: Amon, project: OBS, type: reanaly,
         version: TS4.02, tier: 2}
      - {dataset: ACCESS1-3, project: CMIP5, mip: Amon, exp: historical,
         ensemble: r1i1p1}
      - {dataset: GISS-E2-H, project: CMIP5, mip: Amon, exp: historical,
         ensemble: r1i1p1}

    scripts:
      script1:
        script: droughtindex/diag_save_spi.R
        smooth_month: 6
        # distribution: "Gamma" usually for SPI.
        # distribution: "log-Logistic" usually for SPEI-
        # Also available distribution: "PearsonIII"
        distribution: "Gamma"

  spi_collect:
    description: Wrapper to collect and plot previously calculated SPEI index
    scripts:
      spi_collect:
        script: droughtindex/collect_drought_obs_multi.py
        indexname: "SPI"
        # Threshold under which an event is defined as drought.
        # Usually -2.0 for SPI and SPEI.
        threshold: -2.0
        ancestors: ['diagnostic1/script1']