# ESMValTool
# recipe_ocean_bcg.yml
---
documentation:
  title: Marine Biogeochemistry analysis suite

  description: |
    Recipe to evaluate the marine biogeochemistry models of CMIP5.
    There are also some physical evaluation metrics here too.
    This work based on the BGC-val toolkit GMD-2018-103.
    DOI: https://doi.org/10.5194/gmd-11-4215-2018
    Written by Lee de Mora, Plymouth Marine Laboratory, ledm@pml.ac.uk

  authors:
    - demora_lee

  maintainer:
    - demora_lee

  references:
    - demora2018gmd

  projects:
    - ukesm


datasets:
  - {dataset: HadGEM2-ES,    project: CMIP5,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}

# working datasets
  # - {dataset: CanESM2,       project: CMIP5,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
  # - {dataset: CanCM4,    project: CMIP5,   exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
  # - {dataset: CSIRO-Mk3-6-0,    project: CMIP5,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
  # - {dataset: GISS-E2-H,    project: CMIP5,   exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
  # - {dataset: HadGEM2-AO,    project: CMIP5,   exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
  # - {dataset: HadGEM2-CC,    project: CMIP5,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
  # - {dataset: HadCM3,    project: CMIP5,    exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}

###
# Problem with times
#  - {dataset: MIROC-ESM,    project: CMIP5,  mip: Oyr,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
#  - {dataset: MIROC-ESM-CHEM,    project: CMIP5,  mip: Oyr,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}

# Unstructured grids
#  - {dataset: MPI-ESM-LR,  project: CMIP5,  mip: Oyr,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2003}
#  - {dataset: MPI-ESM-MR,  project: CMIP5,  mip: Oyr,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
#  - {dataset: ACCESS1-0,    project: CMIP5,  mip: Oyr,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}
#  - {dataset: ACCESS1-3,    project: CMIP5,  mip: Oyr,  exp: historical,  ensemble: r1i1p1,  start_year: 2001,  end_year: 2004}


# --------------------------------------------------
# Preprocessors
# --------------------------------------------------
preprocessors:
  # Global 3D Volume-weighted Average
  prep_timeseries_global_volume_average:
    custom_order: true
    volume_statistics:
      operator: mean
    #multi_model_statistics:
    #  span: overlap
    #  statistics: [mean]
    #  exclude: ['WOA']

  # Global area-weighted Average from 2D field
  prep_global_Surface_average_timeseries_2D:
    custom_order: true
    area_statistics:
      operator: mean
    #multi_model_statistics:
    #  span: overlap
    #  statistics: [mean]
    #  exclude: ['WOA']

  # Global area -weighted surface Average from 3D field
  prep_global_Surface_average_timeseries_3D:
    custom_order: true
    extract_levels:
      levels:  [0., ]
      scheme: linear_extrapolate
    area_statistics:
      operator: mean
    #multi_model_statistics:
    #  span: overlap
    #  statistics: [mean]
    #  exclude: ['WOA']

  prep_timeseries_scalar: # Load file as is.
    custom_order: true


  # For a 2D global surface map
  prep_surface_map_2D:
    climate_statistics:
      operator: mean

  # For a 3D global surface map
  prep_surface_map_3D:
    extract_levels:
      levels:  [0., ]
      scheme: linear_extrapolate
    climate_statistics:
      operator: mean

  prep_surface_map_regrid_3D:
    custom_order: true
    extract_levels:
      levels:  [0., ]
      scheme: linear_extrapolate
    climate_statistics:
      operator: mean
    regrid:
      target_grid: 1x1
      scheme: linear


  prep_global_profile:
    annual_statistics:
      operator: mean
    area_statistics:
      operator: mean

  prep_global_profile_decadal:
    decadal_statistics:
      operator: mean
    area_statistics:
      operator: mean

  prep_transect_AMT: # Atlantic Meridional Transect (28W)
    custom_order: true
    climate_statistics:
      operator: mean
    extract_region:
      start_longitude: 320.
      end_longitude: 345.
      start_latitude: -81.
      end_latitude: 89.9
    regrid:
      target_grid: 1x1
      scheme: linear
    extract_transect:
      longitude: 332.

#   # 2D map global depth integration
#   prep_depth_integration:
#     depth_integration:
# #      new_units: kg m-2 # need to specify in advance, as cf_units has strange behaviour.
#     climate_statistics:
#      operator: mean
#
#   # 2D map global depth integration time series maps
#   prep_depth_integration_timeseries:
#     custom_order: true
#     depth_integration:
#     area_statistics:
#       operator: mean


# --------------------------------------------------
# Diagnostics
# --------------------------------------------------
diagnostics:
# Need to add:
    # Global Air sea flux of CO2

# Added:
    # Global volume average Temperature time series
    # Global volumne average salinity time series
    # Drake passge/AMOC (if exists as scalar field)
    # Global net integrated primary production timeseries
    # Global surface mean chlorophyll timeseries
    # Global surface mean nutrients timeseries
    # Global surface mean chlorophyll map
    # Global surface mean nutrients map
    # Global net integrated primary production map


  # --------------------------------------------------
  # Map diagnostics - vs WOA
  # --------------------------------------------------
  diag_surface_maps_vs_WOA:
    description: Global Ocean Surface maps vs WOA
    variables:
      thetao:
        preprocessor: prep_surface_map_regrid_3D
        mip: Omon
        additional_datasets:
          - {dataset: WOA,  project: OBS,  type: clim,  version: 2013v2,  start_year: 2000,  end_year: 2000,  tier: 2}
      so:
        preprocessor: prep_surface_map_regrid_3D
        mip: Omon
        additional_datasets:
          - {dataset: WOA,  project: OBS,  type: clim,  version: 2013v2,  start_year: 2000,  end_year: 2000,  tier: 2}
      no3:
        preprocessor: prep_surface_map_regrid_3D
        mip: Oyr
        additional_datasets:
          - {dataset: WOA,  project: OBS,  type: clim,  version: 2013v2,  start_year: 2000,  end_year: 2000,  tier: 2}
      si: # Silicate
        preprocessor: prep_surface_map_regrid_3D
        mip: Oyr
        additional_datasets:
          - {dataset: WOA,  project: OBS,  type: clim,  version: 2013v2,  start_year: 2000,  end_year: 2000,  tier: 2}
      o2: # Oxygen
        preprocessor: prep_surface_map_regrid_3D
        mip: Oyr
        additional_datasets:
          - {dataset: WOA,  project: OBS,  type: clim,  version: 2013v2,  start_year: 2000,  end_year: 2000,  tier: 2}
      areacello:
        mip: fx
    #   po4:
    #     preprocessor: prep_surface_map_3D
    #     mip: Oyr
    #     additional_datasets:
    #       - {dataset: WOA,  project: OBS,  type: clim,  version: 2013v2,  start_year: 2000,  end_year: 2000,  tier: 2}
    scripts:
      Global_Ocean_surface_map:
        script: ocean/diagnostic_maps.py

        #Global_Ocean_model_vs_obs:
        #script: ocean/diagnostic_model_vs_obs.py
        #observational_dataset: {dataset: WOA, project: OBS}