`nrel.hive.runner.local_simulation_runner`

Module Contents

Classes

LocalSimulationRunner

The local simulation runner.

Functions

_run_step_in_context(→ Callable)

Attributes

nrel.hive.runner.local_simulation_runner.log[source]

class nrel.hive.runner.local_simulation_runner.LocalSimulationRunner[source]

Bases: NamedTuple

The local simulation runner.

classmethod run(runner_payload: nrel.hive.runner.runner_payload.RunnerPayload) → nrel.hive.runner.runner_payload.RunnerPayload[source]

steps through time, running a simulation, and producing a simulation result

Parameters:: runner_payload – the initial state of the simulation
Returns:: the final simulation state and dispatcher state

classmethod step(runner_payload: nrel.hive.runner.runner_payload.RunnerPayload) → nrel.hive.runner.runner_payload.RunnerPayload | None[source]

takes exactly one step forward, or, if the simulation has reached the end time, does nothing

Parameters:: runner_payload – the current state of the simulation
Returns:: the next simulation state after one simtime step, or, None if we have reached the end_time

nrel.hive.runner.local_simulation_runner._run_step_in_context(env: nrel.hive.runner.environment.Environment) → Callable[source]