LMDZ/SACS LMDZ/SACS

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

active_species : mandatory

List of active species / tracers. Each species requires a parameter in a ‘inicond’ component

Argument structure:

any_key : optional

Name of a species.

Argument structure:

molar_mass : float, mandatory

Molar mass of the species

restart_id : int, optional

ID in the restart file (with ‘q’ at the beginning)

Optional arguments

emitted_species : list, optional

List of emitted species, must be included in ‘active_species’. Each species requires a parameter in a ‘flux’ component. By default, all species in ‘active_species’ are emitted.

prescribed_species : list, optional, default []

List of prescribed species. Each species requires a parameter in a ‘prescrconcs’ component

prodloss_species : list, optional, default []

List of production/loss species, must be included in ‘active_species’. Each species requires a parameter in a ‘prodloss’ component

deposition_species : list, optional, default []

List of deposition species, must be included in ‘active_species’. Each species requires a parameter in a ‘deposition’ component

reactions : list, optional, default []

List of reactions.

YAML template

Please find below a template for a YAML configuration:

chemistry:
  plugin:
    name: LMDZ
    version: SACS
    type: chemistry

  # Mandatory arguments
  active_species:
    any_key:
      molar_mass: XXXXX  # float
      restart_id: XXXXX  # int

  # Optional arguments
  emitted_species: XXXXX  # list
  prescribed_species: XXXXX  # list
  prodloss_species: XXXXX  # list
  deposition_species: XXXXX  # list
  reactions: XXXXX  # list