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: str
domid: (mandatory)
Name of the domain
accepted type: str
nlev: (mandatory)
Number of vertical levels
accepted type: int
p1: (mandatory)
Pressure at the top of the first layer
accepted type: float
pmax: (mandatory)
Pressure at the top of the domain
accepted type: 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: bool
stretching: (optional): 0
Coefficient used to stretch domain regular in kilometers
accepted type: float
buffer_layer: (optional): 0
Buffer layer near the surface
accepted type: float
dir_landuse: (optional):
Path to GLCF data
accepted type: str
file_aggregation: (optional):
Path to the file LAND_AGGREGATION
accepted type: str
dx: (optional):
size of cells in longitude
accepted type: float
dy: (optional):
size of cells in latitude
accepted type: 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: float
ycenter: (optional):
latitude of the center of the domain (used with ‘km’ type)
accepted type: float
nlon: (optional):
number of cells in longitude (used with ‘km’ type)
accepted type: int
nlat: (optional):
number of cells in latitude (used with ‘km’ type)
accepted type: int
xmin: (optional):
longitude of the East side of the domain (used with ‘deg’ type)
accepted type: float
xmax: (optional):
longitude of the West side of the domain (used with ‘deg’ type)
accepted type: float
ymin: (optional):
latitude of the South side of the domain (used with ‘deg’ type)
accepted type: float
ymax: (optional):
latitude of the North side of the domain (used with ‘deg’ type)
accepted type: 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 # str
9 domid: XXXXX # str
10 nlev: XXXXX # int
11 p1: XXXXX # float
12 pmax: XXXXX # float
13
14 # Optional arguments
15 pressure_unit: XXXXX # Pa|hPa
16 emissublayer: XXXXX # bool
17 stretching: XXXXX # float
18 buffer_layer: XXXXX # float
19 dir_landuse: XXXXX # str
20 file_aggregation: XXXXX # str
21 dx: XXXXX # float
22 dy: XXXXX # float
23 type: XXXXX # km|deg
24 xcenter: XXXXX # float
25 ycenter: XXXXX # float
26 nlon: XXXXX # int
27 nlat: XXXXX # int
28 xmin: XXXXX # float
29 xmax: XXXXX # float
30 ymin: XXXXX # float
31 ymax: XXXXX # float
