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:

Optional arguments

autoflush: (optional): False

Cleans big temporary files when the simulation is done. Triggers the function flushrun of the model if available

accepted type: <class ‘bool’>

read_background: (optional): False

Read sensitivity to the background according to FLEXPART

accepted type: <class ‘bool’>

read_surface_sensitivity: (optional): True

Read sensitivity to the surface fluxes according to FLEXPART

accepted type: <class ‘bool’>

periods: (optional): 1MS

Length of periods along which FLEXPART simulations are split

accepted type: <class ‘str’>

footprint_dir_format: (optional): %Y%m

Structure for the footprints per stations. The format can use date formatting

accepted type: str

footprint_date_format: (optional): %Y%m%d%H%M%S

Date format for converting observation dates to footprint data

accepted type: str

flexversion: (optional): 10.4

Version of FLEXPART used to generate footprints

accepted type: <class ‘float’>

release_shift: (optional): 0H

Releases start X time before observation starts. Accepts pandas date syntax

accepted type: <class ‘str’>

footprint_format: (optional): bin

Format of FLEXPART output files ‘grid_time’

accepted values:

  • bin: standard FLEXPART outputs

  • nc: netCDF adaptation of FLEXPART outputs

force_read_nest: (optional): False

Use it to force using the nested format even when simulations where nested, but the CIF uses them as non-nested. It has no impact for nested simulations, but for non-nested, if the original FLEXPART simulation was nested and force_read_nest is False, the CIF will use the outer domain by default, which may lead to shape issues

accepted type: <class ‘bool’>

dump_debug: (optional): False

Dumps intermediate datastores (contributions from nested fluxes, global fluxes and initial conditions) in the model sub-directory

accepted type: <class ‘bool’>

backward_trajdays: (optional):

Duration of backward trajectories

accepted type: <class ‘str’>

ref_header_ID: (optional)

Name of the station to be used to initialize the header for the model footprints

accepted type: <class ‘str’>

nthreads: (optional): 1

Number of threads to read in parallel grid files. There is a balance to find between to few threads which do not optimize anything and too many threads that overload I/O.

accepted type: <class ‘int’>


The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version













Yaml template

Please find below a template for a Yaml configuration:

 2  plugin:
 3    name: FLEXPART
 4    version: std
 5    type: model
 8  # Optional arguments
 9  autoflush: XXXXX
10  read_background: XXXXX
11  read_surface_sensitivity: XXXXX
12  periods: XXXXX
13  footprint_dir_format: XXXXX
14  footprint_date_format: XXXXX
15  flexversion: XXXXX
16  release_shift: XXXXX
17  footprint_format: XXXXX
18  force_read_nest: XXXXX
19  dump_debug: XXXXX
20  backward_trajdays: XXXXX
21  ref_header_ID: XXXXX
22  nthreads: XXXXX