eelib.core.forecast.forecast_simulator

Mosaik interface for the eELib energy management system (EMS) forecast. Simulator for communication between orchestrator (mosaik) and forecast.

Within this interface mosaik functionalities are used. Copyright (c) LGPL

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

Sim

Simulator class for eELib forecast model.

Attributes

META

ADAPTION_TOLERANCE

META
ADAPTION_TOLERANCE = '1e-05'
class Sim

Bases: mosaik_api_v3.Simulator

Simulator class for eELib forecast model.

output_cache
entities
init(sid: str, scenario_config: dict, time_resolution: int = 1) → dict

Initializer for Prognosis:Sim class.

Parameters:

  • sid (str) – ID of the created entity of the simulator (e.g. PrognosisSim-0)

  • scenario_config (dict) – scenario configuration data, like resolution or step size

  • time_resolution (int) – fitting of the step size to the simulation scenario step size.

Returns:

description of the simulator

Return type:

dict

create(num: int, model_type: str = 'forecast', init_vals: dict = {'Forecast_0': {}}) → dict

Creates entities of the eELib forecast model. Core function of mosaik.

Parameters:

  • num (int) – number of models to be created

  • model_type (str) – type of created entity, defaults to “forecast”

  • init_vals (dict) – list with initial values for entities, defaults to {“Forecast_0”:{}}

Raises:

ValueError – If entity ID is already existing

Returns:

created entities

Return type:

dict

get_entity_by_id(entity_id: str) → eelib.core.forecast.forecast_model.Forecast

Searches for a requested entity id and gives back the entity model.

Parameters:

entity_id (str) – id of the entity to be searched for

Returns:

entity model if found, None otherwise

Return type:

forecast_model.Forecast

step(time: int, inputs: dict, max_advance: int) → int

Performs simulation step calling the eELib forecast model. Core function of mosaik.

Parameters:

  • time (int) – current simulation time (given by mosaik)

  • inputs (dict) – allocation of set values to specific models

  • max_advance (int) – simulation time until the simulator can safely advance it’s internal time without causing any causality errors.

Raises:

TypeError – if input has unknown format

Returns:

next timestep (when orchestrator calls again)

Return type:

int

get_data(outputs: dict) → dict

Gets the data for the next concatenated model. Core function of mosaik.

Parameters:

outputs (dict) – dictionary with data outputs from each prognosed model

Raises:

ValueError – error if attribute not in model metadata

Returns:

dictionary with simulation outputs

Return type:

dict

add_forecasted_entity(prognosed_entity_id: str, entity_dict: dict)

Adds entities (e.g. pv systems) to the specific forecast unit.

Parameters:

  • prognosed_entity_id (str) – Dictionary of forecast entity

  • entity_dict (dict) – Dictionary of created models to be added to the forecast entity