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

footprint_type: (optional): FLEXPART

Type of footprints to read

accepted values:

  • FLEXPART: Footprints generated by FLEXPART

  • STILT: Footprints generated by STILT

period: (optional): 1MS

Length of periods along which FLEXPART simulations are split

accepted type: <class ‘str’>

subperiod: (optional):

Complementary to period if inputs should be at a better resolution than period

accepted type: <class ‘str’>

numscale: (optional): 1000000000000.0

Scaling factor to convert from footprint native resolution to`ppm / (ng/m2/s)`

accepted type: <class ‘float’>

coeff: (optional): 0.001

Conversion coefficient to convert from native output unit to ppb/ppt/ppm, etc. A coefficient of 1 returns ppm; 1e-3 returns ppb, etc.

accepted type: <class ‘float’>

mmair: (optional): 28.97

Molar mass of dry air

accepted type: <class ‘float’>

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: <class ‘str’>

file_nest_format: (optional):

Format of the footprint file names.


It is possible to dynamically include the name of the station in file_nest_format (but also in footprint_date_format and footprint_dir_format.

To do so, simply include the string {stat} in the variable.

For instance, if file_nest_format is footprint_{stat}_%Y%m.nc, it will be replaced by footprint_PAL_201001.nc for the station PAL for the month of January 2010.

accepted type: <class ‘str’>

run_dir_nest: (optional):

Directory where footprints for the nested domain are stored. In the case of a non-nested domain, this argument is used for the overall domain.


The expected structure of the footprint folder is:

run_dir_nest ├── station_ID#1 │ └── footprint_dir_format │ └── file_nest_format └── station_ID#1

└── footprint_dir_format

└── file_nest_format

accepted type: <class ‘str’>

run_dir_glob: (optional):

Same as run_dir_nest for the outer domain.


For non-nested domains, run_dir_glob is used by default to read footprints. It is possible to force reading the inside domain with force_read_nest

accepted type: <class ‘str’>

run_dir_bg: (optional):

Same as run_dir_nest for reading the influence of the background.

accepted type: <class ‘str’>

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. If not specified, automatically inferred from the domain information.


This argument should be explicitly specified only with STILT

accepted type: <class ‘str’>

ref_header_ID: (optional)

Name of the station to be used to initialize the header for the model footprints. If not specified, The first station of the observation files will be used.

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

flexversion: (optional): 10.4

Version of FLEXPART used to generate footprints

accepted type: <class ‘float’>


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  footprint_type: XXXXX
13  period: XXXXX
14  subperiod: XXXXX
15  numscale: XXXXX
16  coeff: XXXXX
17  mmair: XXXXX
18  footprint_dir_format: XXXXX
19  footprint_date_format: XXXXX
20  file_nest_format: XXXXX
21  run_dir_nest: XXXXX
22  run_dir_glob: XXXXX
23  run_dir_bg: XXXXX
24  release_shift: XXXXX
25  footprint_format: XXXXX
26  force_read_nest: XXXXX
27  dump_debug: XXXXX
28  backward_trajdays: XXXXX
29  ref_header_ID: XXXXX
30  nthreads: XXXXX
31  flexversion: XXXXX