CHIMERE / std

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

repgrid: (mandatory)

Path to the directory where the COORD files are to be found. In this directory, file domainlist.nml must be available with the first three columns giving the name of the domain], the number of cells in the zonal direction and the number of cells in the meridian direction [provisionnal configuration as it implies redundant information]. In this directory, the mandatory sub-folders are:${path}/HCOORD/ and ${path}/VCOORD/ containing files COORD_${domain}, COORDcorner_${domain} and VCOORD_${nlev}_{p1}_${pmax} as well as, if deposition is required, sub-folder ${path}/LANDUSE/ containing file LANDUSE_${domain} XXmore required on consistency between eg LU and number of categories either default or in model:nlduseXX COORDcorner_${domain} lists the coordinates of the corners of the horizontal grid cells (longitude, latitude) plus the area (m2) of the cell. COORD_${domain} lists the coordinates of the centers of the horizontal grid cells (longitude, latitude) plus the area (m2) of the cell. LANDUSE_${domain} indicates for each grid cell the fraction of each of the 9 CHIMERE land-use categories [number and types of categories can be changed by experienced users??]

accepted type: <class ‘str’>

domid: (mandatory)

Name of the domain

accepted type: <class ‘str’>

nlev: (mandatory)

Number of vertical levels

accepted type: <class ‘int’>

p1: (mandatory)

Pressure at the top of the first layer

accepted type: <class ‘float’>

pmax: (mandatory)

Pressure at the top of the domain

accepted type: <class ‘float’>

Optional arguments

pressure_unit: (optional): hPa

Unit for the pressure in the VCOORD file

accepted values:

  • Pa: Pascals

  • hPa: hectoPascals

emissublayer: (optional): 0

Use a sub-layer for surface emissions

accepted type: <class ‘bool’>

Yaml template

Please find below a template for a Yaml configuration:

 1domain:
 2  plugin:
 3    name: CHIMERE
 4    version: std
 5    type: domain
 6
 7  # Mandatory arguments
 8  repgrid: XXXXX
 9  domid: XXXXX
10  nlev: XXXXX
11  p1: XXXXX
12  pmax: XXXXX
13
14  # Optional arguments
15  pressure_unit: XXXXX
16  emissublayer: XXXXX