eelib.core.forecast.forecast_model

eELib model for creation of forecast.

Author: elenia@TUBS
Copyright 2024 elenia
This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.

Module Contents

Classes

Forecast

Models a forecast creation/calculation.

Attributes

_logger

_logger
class Forecast(ename: str, step_size: int)

Models a forecast creation/calculation.

_VALID_PARAMETERS
classmethod get_valid_parameters()

Returns dictionary containing valid parameter types and values.

Returns:

valid parameters for this model

Return type:

dict

step(time: int)

Perform simulation step for the forecast model.

Parameters:

time (int) – Current simulation time

Raises:

TypeError – Forecast is requested for an entity that is not added to forecast list

add_forecasted_entity(entity_dict: dict)

Adds a entity for the forecast to the corresponding forecast’ lists.

Parameters:

entity_dict (dict) – Input list with all entities of a type (e.g. pv) for which a forecast will be made.