Computing a transport model run_model/std

Computing a transport model run_model/std#

Description#

run_model transform: execute the numerical transport model.

Wraps model.make_auxiliary (generates auxiliary input files) and model.run (executes the model executable) for one sub-simulation period. On first use, compiles the model via model.compile if that method is present.

Also binds the four model I/O functions (native2inputs, native2inputs_adj, outputs2native, outputs2native_adj) to the plugin instance so that dump2inputs and loadfromoutputs can retrieve them via the transform pipeline.

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#

parameter : str, optional

Parameter name on which the transform works on

component : str, optional

Component name on which the transform works on

orig_parameter_plg : Plugin, optional

Plugin object on which the transform works on

orig_component_plg : Plugin, optional

Corresponding component object on which the transform works on

successor : str, optional

Name of the successor transform

precursor : str, optional

Name of the precursor transform

Requirements#

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

model

Model

False

True

None

None

YAML template#

Please find below a template for a YAML configuration:

 1transform:
 2  plugin:
 3    name: run_model
 4    version: std
 5    type: transform
 6
 7  # Optional arguments
 8  parameter: XXXXX  # str
 9  component: XXXXX  # str
10  orig_parameter_plg: XXXXX  # Plugin
11  orig_component_plg: XXXXX  # Plugin
12  successor: XXXXX  # str
13  precursor: XXXXX  # str

See also

API reference (functions & code)