DIAGMET meteorological processing for CHIMERE (diagmet / std)

Description

This transform replicates what was done in the historical diagmet.f90 script associated to CHIMERE. It processes variables from ECMWF grib files to produce variables required by CHIMERE.

Warning

At the moment, the yaml is not convenient to use. Every input parameter must be included. In the future, something equivalent to ecm_par.f90 should be implemented.

For the time being, please use the following yaml sample in your datavect paragraph:

meteo:
  plugin:
    name: CHIMERE
    version: std
    type: meteo
  file_freq: 3H
  dir: /home/comdata1/Meteo/europe160/%Y/%m/
  regrid:
    method: mass-conservation
  parameters:
    winm:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: v
      file: uvtqc.160europe.%Y%m%d{di}00%H.grb2
    winz:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: u
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: uvtqc.160europe.%Y%m%d{di}00%H.grb2
    temp:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: t
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: uvtqc.160europe.%Y%m%d{di}00%H.grb2
    sphu:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: q
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: uvtqc.160europe.%Y%m%d{di}00%H.grb2
    clwc:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: clwc
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: uvtqc.160europe.%Y%m%d{di}00%H.grb2
    dpdu:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: p106.162
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: deepconv.160europe.%Y%m%d{di}00%H.grb2
      decumul: True
      unit_conversion:
        scale: 9.259259259259259e-05
    upfl:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: p104.162
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: deepconv.160europe.%Y%m%d{di}00%H.grb2
      decumul: True
      unit_conversion:
        scale: 9.259259259259259e-05
    dwfl:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: p105.162
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: deepconv.160europe.%Y%m%d{di}00%H.grb2
      decumul: True
      unit_conversion:
        scale: 9.259259259259259e-05
    dpdd:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: p107.162
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: deepconv.160europe.%Y%m%d{di}00%H.grb2
      decumul: True
      unit_conversion:
        scale: 9.259259259259259e-05
    psurf:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: sp
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
    hght:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: blh
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
    u10m:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: u10
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
    v10m:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: v10
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
    tem2:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: t2m
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
    sshf:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: sshf
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
      decumul: True
      unit_conversion:
        scale: -9.259259259259259e-05
    slhf:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: slhf
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
      decumul: True
      unit_conversion:
        scale: -9.259259259259259e-05
    lspc:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: lsp
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
      decumul: True
      unit_conversion:
        scale: 333.333
    copc:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: cp
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
      decumul: True
      unit_conversion:
        scale: 333.333
    clol:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: lcc
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
    clom:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: mcc
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True
    cloh:
      plugin:
        name: ECMWF
        version: grib2
        type: field
      varname: hcc
      dir: /home/comdata1/Meteo/europe160/%Y/%m/
      file: 2d.160europe.%Y%m%d{di}00%H.grb2
      surface: True

Yaml arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Mandatory arguments

file_landuse: (mandatory)

Path to the LANDUSE file (computed elsewhere)

accepted type: <class ‘str’>

file_landpar: (mandatory)

Path to the LANDPAR file

accepted type: <class ‘str’>

Optional arguments

pblmin: (optional): 20

Minimum PBL height

accepted type: <class ‘float’>

uwinfac: (optional): False

Use urban wind correction in the surface layer.

Warning

In the original diagmet, the values were inverted. One should use 1 to disable the function and 0 to activate it. Now, True means using it and False not using it.

accepted type: <class ‘bool’>

uflxadd: (optional): False

Use additional urban heat flux

accepted type: <class ‘bool’>

upblmin: (optional): False

Use urban correction for minimal urban PBL height

accepted type: <class ‘bool’>

cice: (optional): True

Use cloud ice water in addition to cloud liquid water

accepted type: <class ‘bool’>

rain: (optional): False

Use rain water in addition to cloud liquid water

accepted type: <class ‘bool’>

clol: (optional): 0

Use low clouds: 0 = read, 1 = use liquid water, 2 = use relative humidity

accepted type: <class ‘int’>

clom: (optional): 0

Use medium clouds: 0 = read, 1 = use liquid water, 2 = use relative humidity

accepted type: <class ‘int’>

cloh: (optional): 0

Use high clouds: 0 = read, 1 = use liquid water, 2 = use relative humidity

accepted type: <class ‘int’>

usta: (optional): recompute

Read Ustar or recompute from Louis 1982

accepted values: [‘read’, ‘recompute’]

deepc: (optional): True

Read deep convection (it False, put all DP fluxes at 0)

accepted type: <class ‘bool’>

Requirements

The current plugin requires the present plugins to run properly:

Requirement name	Requirement type	Explicit definition	Any valid	Default name	Default version
model	Model	False	False	CHIMERE	std

Yaml template

Please find below a template for a Yaml configuration:

transform:
  plugin:
    name: diagmet
    version: std
    type: transform

  # Mandatory arguments
  file_landuse: XXXXX
  file_landpar: XXXXX

  # Optional arguments
  pblmin: XXXXX
  uwinfac: XXXXX
  uflxadd: XXXXX
  upblmin: XXXXX
  cice: XXXXX
  rain: XXXXX
  clol: XXXXX
  clom: XXXXX
  cloh: XXXXX
  usta: XXXXX
  deepc: XXXXX