documentation:
  description: |
    Recipe to generate the netCDF files to compute ToE
    Written by Jean Negrel, NORCE, jene@norceresearch.no

  authors:
    - lovato_tomas
  
  maintainer:
    - lovato_tomas

  references:
    - acknow_project

  projects:
    - crescendo

# --------------------------------------------------
# Datasets
# --------------------------------------------------
DATASET_ANCHOR_piC: &datasets_hist
   - {dataset: ACCESS-ESM1-5,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: CanESM5,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p2f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: CanESM5-CanOE,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p2f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: CESM2,        project: CMIP6,    exp: [historical,ssp585],    ensemble: r10i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: CESM2-WACCM,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: CMCC-ESM2,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: CNRM-ESM2-1,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f2,    grid: gn,    start_year: 2001,    end_year: 2100}
#   - {dataset: EC-Earth3-CC,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: GFDL-CM4,     project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gr,    start_year: 2001,    end_year: 2100}
   - {dataset: GFDL-ESM4,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gr,    start_year: 2001,    end_year: 2100}
   - {dataset: IPSL-CM6A-LR,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: MPI-ESM1-2-HR,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: MPI-ESM1-2-LR,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: MRI-ESM2-0,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i2p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: NorESM2-MM,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: NorESM2-LM,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f1,    grid: gn,    start_year: 2001,    end_year: 2100}
   - {dataset: UKESM1-0-LL,    project: CMIP6,    exp: [historical,ssp585],    ensemble: r1i1p1f2,    grid: gn,    start_year: 2001,    end_year: 2100}

SELECT_REGION: &select_region 
#   - { start_longitude: 0., end_longitude: 360., start_latitude:  -70., end_latitude: -45. } # South Ocean
#   - { start_longitude: 0., end_longitude: 360., start_latitude:  -45., end_latitude: 90. } # SO-exclusive
   - { start_longitude: 0., end_longitude: 360., start_latitude:  -90., end_latitude: 90. } # Global
   #- { shapefile: /users_home/oda/tl28319/Scripts/CE2COAST/shapes/mediterranean_sea.shp }

# --------------------------------------------------
# Preprocessors
# --------------------------------------------------
preprocessors:
  prep_ts_Glob:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_region:
      start_longitude: 0.
      end_longitude: 360.
      start_latitude:  -90.
      end_latitude: 90. # Global
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_SO:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_region:
      start_longitude: 0.
      end_longitude: 360.
      start_latitude:  -70.
      end_latitude: -45. # South Ocean
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_mSO:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_region:
      start_longitude: 0.
      end_longitude: 360.
      start_latitude:  -45.
      end_latitude: -15. # mSO
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_Arc:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_region:
      start_longitude: 0.
      end_longitude: 360.
      start_latitude:  60.
      end_latitude: 90. # Arctic
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_TPa:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_shape:
      shapefile: '/nird/home/jene/Data/Shapefiles/TPa.shp'
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_NPa:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_shape:
      shapefile: '/nird/home/jene/Data/Shapefiles/NPa.shp'
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_TAt:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_shape:
      shapefile: '/nird/home/jene/Data/Shapefiles/TAt.shp'
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_NAt:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_shape:
      shapefile: '/nird/home/jene/Data/Shapefiles/NAt.shp'
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']

  prep_ts_Ind:
    custom_order: true
    regrid:
      target_grid: 1x1
      scheme: linear
    annual_statistics:
      operator: mean
    extract_shape:
      shapefile: '/nird/home/jene/Data/Shapefiles/Ind.shp'
    area_statistics:
      operator: mean
    multi_model_statistics:
      span: overlap
      statistics: [mean]
      exclude: ['Landschuetzer2016']


# --------------------------------------------------
# Diagnostics
# --------------------------------------------------
diagnostics:
  ts_Glob:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_Glob
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_SO:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_SO
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_mSO:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_mSO
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_TPa:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_TPa
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_NPa:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_NPa
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_TAt:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_TAt
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_NAt:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_NAt
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_Ind:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_Ind
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true

  ts_Arc:
    description: area weighted timeseries
    additional_datasets: *datasets_hist
    variables:
      fgco2:
        preprocessor: prep_ts_Arc
        mip: Omon
        additional_datasets:
          - {dataset: Landschuetzer2016,  project: OBS,  type: clim,  version: v2016,  start_year: 2001,  end_year: 2010,  tier: 2}
    scripts:
      timeseries:
        script: ocean/diagnostic_timeseries.py
        plot_single: true