TM5/SINK-TIPP TM5/SINK-TIPP

TM5/SINK-TIPP TM5/SINK-TIPP#

Description#

TM5 chemistry plugin (SINK-TIPP scheme).

Manages the chemical-scheme files used by the TM5 global transport model. The scheme relies on two external directories:

  • dir_tipp — kinetics files (TIPP format); linked as {dirchem_ref}/TIPP.

  • dir_sink — sink/deposition files; linked as {dirchem_ref}/SINKS.

The species lists (acspecies, emis_species, bio_species, …) follow the same structure as the CHIMERE chemistry plugin and can be populated either from the YAML or from pre-existing scheme files via read_chemicalscheme.

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#

dir_tipp : str, mandatory

Path to kinetics files

YAML template#

Please find below a template for a YAML configuration:

1chemistry:
2  plugin:
3    name: TM5
4    version: SINK-TIPP
5    type: chemistry
6
7  # Mandatory arguments
8  dir_tipp: XXXXX  # str

See also

API reference (functions & code)