# ESMValTool
# recipe_ocean_amoc.yml
---
documentation:
  title: Atlantic Meridional Overturning Circulation Recipe
  
  description: |
    Recipe to produce time series figures of the derived variable, the
    Atlantic meriodinal overturning circulation (AMOC).
    This recipe also produces transect figures of the stream functions for
    the years 2001-2004.

  authors:
    - demora_lee

  maintainer:
    - demora_lee

  references:
    - demora2018gmd

  projects:
    - ukesm


preprocessors:
  prep_timeseries_drake:
    extract_named_regions:
      regions: drake_passage

  prep_transect:
    custom_order: true
    extract_named_regions:
      regions: atlantic_arctic_ocean
    extract_time:
      start_year: 2001
      start_month: 1
      start_day: 1
      end_year: 2003
      end_month: 12
      end_day: 31
    climate_statistics:
      operator: mean

  # Include units converter to [Tg s-1] for CMIP6 datasets
  prep_transect_cmip6:
    custom_order: true
    extract_named_regions:
      regions: atlantic_arctic_ocean
    extract_time:
      start_year: 2001
      start_month: 1
      start_day: 1
      end_year: 2003
      end_month: 12
      end_day: 31
    climate_statistics:
      operator: mean
    convert_units:
      units: Tg s-1

diagnostics:
  # --------------------------------------------------
  # Time series diagnostics
  # --------------------------------------------------
  diag_timeseries_amoc:
    description: atlantic_meridional_overturning_circulation
    variables:
      amoc:
        mip: Omon
        derive: true
        force_derivation: false
    additional_datasets:
      - {dataset: NorESM1-M,  project: CMIP5, exp: historical, ensemble: r1i1p1,   start_year: 1860, end_year: 2004}
      - {dataset: NorESM1-ME, project: CMIP5, exp: historical, ensemble: r1i1p1,   start_year: 1860, end_year: 2004}
      - {dataset: NorESM2-LM, project: CMIP6, exp: historical, ensemble: r1i1p1f1, start_year: 1860, end_year: 2004, grid: grz}
      - {dataset: NorESM2-MM, project: CMIP6, exp: historical, ensemble: r1i1p1f1, start_year: 1860, end_year: 2004, grid: grz}
    scripts:
      AMOC_timeseries:
        script: ocean/diagnostic_timeseries.py
        moving_average: 6 years

  diag_timeseries_drake:
    description: Drake_passge_current
    variables:
      mfo:
        preprocessor: prep_timeseries_drake
        mip: Omon
    additional_datasets:
      - {dataset: NorESM1-M,  project: CMIP5, exp: historical, ensemble: r1i1p1,   start_year: 1860, end_year: 2004}
      - {dataset: NorESM1-ME, project: CMIP5, exp: historical, ensemble: r1i1p1,   start_year: 1860, end_year: 2004}
      - {dataset: NorESM2-LM, project: CMIP6, exp: historical, ensemble: r1i1p1f1, start_year: 1860, end_year: 2004, grid: gn}
      - {dataset: NorESM2-MM, project: CMIP6, exp: historical, ensemble: r1i1p1f1, start_year: 1860, end_year: 2004, grid: gn}
    scripts:
     Drake_timeseries:
        script: ocean/diagnostic_timeseries.py
        moving_average: 6 years


  # --------------------------------------------------
  # Transect diagnostics
  # --------------------------------------------------
  diag_transects:
    description: Stream function zonal mean
    variables:
      msftmyz:
        preprocessor: prep_transect
        mip: Omon
        additional_datasets:
          - {dataset: NorESM1-M,  project: CMIP5, exp: historical, ensemble: r1i1p1,   start_year: 2000, end_year: 2004}
          - {dataset: NorESM1-ME, project: CMIP5, exp: historical, ensemble: r1i1p1,   start_year: 2000, end_year: 2004}
      msftmz:
        preprocessor: prep_transect_cmip6
        mip: Omon
        additional_datasets:
          - {dataset: NorESM2-LM, project: CMIP6, exp: historical, ensemble: r1i1p1f1, start_year: 2000, end_year: 2004, grid: grz}
          - {dataset: NorESM2-MM, project: CMIP6, exp: historical, ensemble: r1i1p1f1, start_year: 2000, end_year: 2004, grid: grz}
    scripts:
      Atlantic_Stream_function_zonal_mean:
        script: ocean/diagnostic_transects.py
        thresholds: [-20, -10., 0., 10., 20.]
        set_y_logscale: False