FLEXPART / 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¶
xmin: (mandatory)
West longitude of the domain
accepted type: <class ‘float’>
xmax: (mandatory)
East longitude of the domain
accepted type: <class ‘float’>
ymin: (mandatory)
South latitude of the domain
accepted type: <class ‘float’>
ymax: (mandatory)
North latitude of the domain
accepted type: <class ‘float’>
nlon: (mandatory)
Number of grid cells in the zonal direction
accepted type: <class ‘float’>
nlat: (mandatory)
Number of grid cells in the meridional direction
accepted type: <class ‘float’>
outheight_header: (mandatory)
Name of the header file in dir_heights
accepted type: <class ‘str’>
Optional arguments¶
nested: (optional): True
Indicate whether the domain is nested or not. For non nested domains, only the ‘nest’ domain is loaded and not the ‘global’ one
accepted type: <class ‘bool’>
xmin_glob: (optional): 0
East longitude of the global domain for the nested case
accepted type: <class ‘float’>
ymin_glob: (optional): 0
South latitude of the global domain for the nested case
accepted type: <class ‘float’>
nlon_glob: (optional): 0
Number of grid cells in the zonal direction for the nested case
accepted type: <class ‘float’>
nlat_glob: (optional): 0
Number of grid cells in the meridional direction for the nested case
accepted type: <class ‘float’>
dx_glob: (optional): 1
Zonal resolution in the nested case
accepted type: <class ‘float’>
dy_glob: (optional): 1
Meridional resolution in the nested case
accepted type: <class ‘float’>
pressure_unit: (optional): hPa
Unit for the pressure in the VCOORD file
accepted values:
Pa: Pascals
hPa: hectoPascals
dir_heights: (optional):
directory where the header defining the output vertical levels of FLEXPART is stored
accepted type: <class ‘str’>
ignore_heights: (optional): False
Ignore the outheight_header and simply generate height at ground level
accepted type: <class ‘str’>
Yaml template¶
Please find below a template for a Yaml configuration:
1domain:
2 plugin:
3 name: FLEXPART
4 version: std
5 type: domain
6
7 # Mandatory arguments
8 xmin: XXXXX
9 xmax: XXXXX
10 ymin: XXXXX
11 ymax: XXXXX
12 nlon: XXXXX
13 nlat: XXXXX
14 outheight_header: XXXXX
15
16 # Optional arguments
17 nested: XXXXX
18 xmin_glob: XXXXX
19 ymin_glob: XXXXX
20 nlon_glob: XXXXX
21 nlat_glob: XXXXX
22 dx_glob: XXXXX
23 dy_glob: XXXXX
24 pressure_unit: XXXXX
25 dir_heights: XXXXX
26 ignore_heights: XXXXX
