`rtm_wrapper.engines.dummy`#

Mock RTM engines. Useful for development.

Module Contents#

`DummyEngine`	Dummy engine that logs its inputs and produces no outputs.
`NotImplementedEngine`	Dummy engine that raises `NotImplementedError` when run.

class DummyEngine(*, outputs: collections.abc.Iterable[OutputName] | None = None)[source]#

Dummy engine that logs its inputs and produces no outputs.

Parameters:: outputs (collections.abc.Iterable[OutputName] | None) –

run_simulation(inputs: rtm_wrapper.simulation.Inputs) → rtm_wrapper.engines.base.EngineOutputs[source]#

Run this RTM module using the given inputs.

Parameters:: inputs (rtm_wrapper.simulation.Inputs) – Input parameter tree.
Return type:: rtm_wrapper.engines.base.EngineOutputs

class NotImplementedEngine(*, outputs: collections.abc.Iterable[OutputName] | None = None)[source]#

Dummy engine that raises NotImplementedError when run.

Parameters:: outputs (collections.abc.Iterable[OutputName] | None) –

abstract run_simulation(inputs: rtm_wrapper.simulation.Inputs) → typing_extensions.Never[source]#

Run this RTM module using the given inputs.

Parameters:: inputs (rtm_wrapper.simulation.Inputs) – Input parameter tree.
Return type:: typing_extensions.Never