Template for model implementation template/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:
Optional arguments#
- autoflush : bool, optional, default False
Cleans big temporary files when the simulation is done. Triggers the function
flushrun
of the model if available- require_domain : bool, optional, default False
Test initializing the template with a domain
- require_chemistry : bool, optional, default False
Test initializing the template with a chemical scheme
- empty_mapper : bool, optional, default True
Initializes an empty mapper
- only_outputs : bool, optional, default False
Initializes a mapper with only concentration outputs
- output_resolution : str, optional, default “1H”
Temporal resolution of outputs
- input_resolution : str, optional, default “1H”
Temporal resolution of inputs
- include_fluxes : bool, optional, default False
Force the preparation of fluxes prior to running the model
YAML template#
Please find below a template for a YAML configuration:
1model:
2 plugin:
3 name: template
4 version: std
5 type: model
6
7 # Optional arguments
8 autoflush: XXXXX # bool
9 require_domain: XXXXX # bool
10 require_chemistry: XXXXX # bool
11 empty_mapper: XXXXX # bool
12 only_outputs: XXXXX # bool
13 output_resolution: XXXXX # str
14 input_resolution: XXXXX # str
15 include_fluxes: XXXXX # bool