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: (optional): False

Cleans big temporary files when the simulation is done. Triggers the function flushrun of the model if available

accepted type: <class ‘bool’>

require_domain: (optional): False

Test initializing the template with a domain

accepted type: <class ‘bool’>

require_chemistry: (optional): False

Test initializing the template with a chemical scheme

accepted type: <class ‘bool’>

empty_mapper: (optional): True

Initializes an empty mapper

accepted type: <class ‘bool’>

only_outputs: (optional): False

Initializes a mapper with only concentration outputs

accepted type: <class ‘bool’>

output_resolution: (optional): 1H

Temporal resolution of outputs

accepted type: <class ‘str’>

input_resolution: (optional): 1H

Temporal resolution of inputs

accepted type: <class ‘str’>

include_fluxes: (optional): False

Force the preparation of fluxes prior to running the model

accepted type: <class ‘bool’>

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
 8  # Optional arguments
 9  autoflush: XXXXX
10  require_domain: XXXXX
11  require_chemistry: XXXXX
12  empty_mapper: XXXXX
13  only_outputs: XXXXX
14  output_resolution: XXXXX
15  input_resolution: XXXXX
16  include_fluxes: XXXXX