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: bool

require_domain: (optional): False

Test initializing the template with a domain

accepted type: bool

require_chemistry: (optional): False

Test initializing the template with a chemical scheme

accepted type: bool

empty_mapper: (optional): True

Initializes an empty mapper

accepted type: bool

only_outputs: (optional): False

Initializes a mapper with only concentration outputs

accepted type: bool

output_resolution: (optional): 1H

Temporal resolution of outputs

accepted type: str

input_resolution: (optional): 1H

Temporal resolution of inputs

accepted type: str

include_fluxes: (optional): False

Force the preparation of fluxes prior to running the model

accepted type: 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  # 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