CHIMERE HCOORD/VCOORD domain (CHIMERE / std)

Description

This plugin creates or reads CHIMERE domains. See the documentation of CHIMERE domains for further information.

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. Details on the structure of this folder are given here

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’>

stretching: (optional): 0

Coefficient used to stretch domain regular in kilometers

accepted type: <class ‘float’>

buffer_layer: (optional): 0

Buffer layer near the surface

accepted type: <class ‘float’>

dir_landuse: (optional):

Path to GLCF data

accepted type: <class ‘str’>

file_aggregation: (optional):

Path to the file LAND_AGGREGATION

accepted type: <class ‘str’>

dx: (optional):

size of cells in longitude

accepted type: <class ‘float’>

dy: (optional):

size of cells in latitude

accepted type: <class ‘float’>

type: (optional):

type of horizontal grid to generate

accepted values: [‘km’, ‘deg’]

xcenter: (optional):

longitude of the center of the domain (used with ‘km’ type)

accepted type: <class ‘float’>

ycenter: (optional):

latitude of the center of the domain (used with ‘km’ type)

accepted type: <class ‘float’>

nlon: (optional):

number of cells in longitude (used with ‘km’ type)

accepted type: <class ‘int’>

nlat: (optional):

number of cells in latitude (used with ‘km’ type)

accepted type: <class ‘int’>

xmin: (optional):

longitude of the East side of the domain (used with ‘deg’ type)

accepted type: <class ‘float’>

xmax: (optional):

longitude of the West side of the domain (used with ‘deg’ type)

accepted type: <class ‘float’>

ymin: (optional):

latitude of the South side of the domain (used with ‘deg’ type)

accepted type: <class ‘float’>

ymax: (optional):

latitude of the North side of the domain (used with ‘deg’ type)

accepted type: <class ‘float’>

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
17  stretching: XXXXX
18  buffer_layer: XXXXX
19  dir_landuse: XXXXX
20  file_aggregation: XXXXX
21  dx: XXXXX
22  dy: XXXXX
23  type: XXXXX
24  xcenter: XXXXX
25  ycenter: XXXXX
26  nlon: XXXXX
27  nlat: XXXXX
28  xmin: XXXXX
29  xmax: XXXXX
30  ymin: XXXXX
31  ymax: XXXXX