`nrel.hive.dispatcher.forecaster.basic_forecaster`

Module Contents

Classes

BasicForecaster

A forecaster that generates a prediction based on the current demand.

class nrel.hive.dispatcher.forecaster.basic_forecaster.BasicForecaster[source]

Bases: nrel.hive.dispatcher.forecaster.forecaster_interface.ForecasterInterface

A forecaster that generates a prediction based on the current demand.

reader: nrel.hive.util.iterators.DictReaderStepper

classmethod build(demand_forecast_file: str) → BasicForecaster[source]

loads a forecaster from a file

Parameters:: demand_forecast_file – the file source
Returns:: a BasicForecaster
Raises:: an exception if there were file loading issues

generate_forecast(simulation_state: hive.state.simulation_state.simulation_state.SimulationState) → Tuple[BasicForecaster, nrel.hive.dispatcher.forecaster.forecast.Forecast][source]

Generate fleet targets to be consumed by the dispatcher.

Parameters:: simulation_state – The current simulation state
Returns:: the update Manager along with the fleet target