FLEXPART/std FLEXPART/std

FLEXPART/std 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 : float, mandatory

West longitude of the domain

xmax : float, mandatory

East longitude of the domain

ymin : float, mandatory

South latitude of the domain

ymax : float, mandatory

North latitude of the domain

nlon : float, mandatory

Number of grid cells in the zonal direction

nlat : float, mandatory

Number of grid cells in the meridional direction

outheight_header : str, mandatory

Name of the header file in dir_heights

Optional arguments#

nested : bool, optional, default True

Indicate whether the domain is nested or not. For non nested domains, only the ‘nest’ domain is loaded and not the ‘global’ one

xmin_glob : float, optional, default 0

East longitude of the global domain for the nested case

ymin_glob : float, optional, default 0

South latitude of the global domain for the nested case

nlon_glob : float, optional, default 0

Number of grid cells in the zonal direction for the nested case

nlat_glob : float, optional, default 0

Number of grid cells in the meridional direction for the nested case

dx_glob : float, optional, default 1

Zonal resolution in the nested case

dy_glob : float, optional, default 1

Meridional resolution in the nested case

pressure_unit : “Pa” or “hPa”, optional, default “hPa”

Unit for the pressure in the VCOORD file

  • “Pa”: Pascals

  • “hPa”: hectoPascals

dir_heights : str, optional, default “”

directory where the header defining the output vertical levels of FLEXPART is stored

ignore_heights : str, optional, default False

Ignore the outheight_header and simply generate height at ground level

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  # float
 9  xmax: XXXXX  # float
10  ymin: XXXXX  # float
11  ymax: XXXXX  # float
12  nlon: XXXXX  # float
13  nlat: XXXXX  # float
14  outheight_header: XXXXX  # str
15
16  # Optional arguments
17  nested: XXXXX  # bool
18  xmin_glob: XXXXX  # float
19  ymin_glob: XXXXX  # float
20  nlon_glob: XXXXX  # float
21  nlat_glob: XXXXX  # float
22  dx_glob: XXXXX  # float
23  dy_glob: XXXXX  # float
24  pressure_unit: XXXXX  # Pa|hPa
25  dir_heights: XXXXX  # str
26  ignore_heights: XXXXX  # str