nrel.hive.state.simulation_state.update.simulation_update

Module Contents

Classes

SimulationUpdateFunction

Helper class that provides a standard way to create an ABC using
class nrel.hive.state.simulation_state.update.simulation_update.SimulationUpdateFunction[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract update(simulation_state: nrel.hive.state.simulation_state.simulation_state.SimulationState, env: nrel.hive.runner.environment.Environment) → Tuple[nrel.hive.state.simulation_state.simulation_state.SimulationState, SimulationUpdateFunction | None][source]

takes a simulation state and modifies it, returning the updated simulation state

Parameters:

  • simulation_state – the state to modify

  • env – the environmental variables for this run

Returns:

the updated sim state, along with any reporting;

as well, an Optionally-updated SimulationUpdate function