ICON-ART/std ICON-ART/std

ICON-ART/std ICON-ART/std#

Description#

ICON-ART chemistry plugin.

Manages the tracers.xml tracer-definition file consumed by the ICON-ART model. Each active species declared in acspecies is mapped to one or more OEM (Online Emission Module) emission categories via the emis_species attribute, and the corresponding XML tracer entries are generated by create_chemicalscheme().

The plugin also produces auxiliary tracers used for ensemble / EnSRF runs (suffixed _POST, _BG, _BG_POST) and maintains mappings between active tracers and their OEM categories for use by the I/O layer.

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#

schemeid : str, mandatory

Name of the chemical scheme

Optional arguments#

dir_precomp : str, optional

Directory where pre-defined chemical schemes are stored. The assumed structure is: ${dir_precomp}/${schemeid}/

acspecies : optional

List of active species and corresponding parameters

Argument structure:
any_key : optional

Name of a species.

Argument structure:
mass : optional

Molar mass of the species

emis_species : optional

Corresponding emitted species (OEM categories)

YAML template#

Please find below a template for a YAML configuration:

 1chemistry:
 2  plugin:
 3    name: ICON-ART
 4    version: std
 5    type: chemistry
 6
 7  # Mandatory arguments
 8  schemeid: XXXXX  # str
 9
10  # Optional arguments
11  dir_precomp: XXXXX  # str
12  acspecies:
13    any_key:
14      mass: XXXXX  # any
15      emis_species: XXXXX  # any

See also

API reference (functions & code)