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:

model:
  plugin:
    name: template
    version: std
    type: model

  # Optional arguments
  autoflush: XXXXX  # bool
  require_domain: XXXXX  # bool
  require_chemistry: XXXXX  # bool
  empty_mapper: XXXXX  # bool
  only_outputs: XXXXX  # bool
  output_resolution: XXXXX  # str
  input_resolution: XXXXX  # str
  include_fluxes: XXXXX  # bool