ICON-ART / std¶
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: (mandatory)
Name of the chemical scheme
accepted type: str
Optional arguments¶
dir_precomp: (optional)
Directory where pre-defined chemical schemes are stored. The assumed structure is:
${dir_precomp}/${schemeid}/accepted type: str
acspecies: (optional)
List of active species and corresponding parameters
- accepted structure:
any_key: (optional)
Name of a species.
- accepted structure:
mass: (optional)
Molar mass of the species
emis_species: (optional): <pycif.utils.classes.chemistries.Chemistry object at 0x7fd675480be0>
List of emitted species with constant emissions on corresponding time steps.
- accepted structure:
any_key: (optional)
Name of a species.
accepted structure:
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:
16 any_key:
