eelib.core.devices.pv.pv_lib_simulator
Mosaik interface for the eELib pvlib pv model. Simulator for communication between orchestrator (mosaik) and pv_lib entities.
Within this interface mosaik functionalities are used. Copyright (c) LGPL
Module Contents
Classes
Simulator class for eELib pv_lib model. |
Attributes
- ADAPTION_TOLERANCE
- META
- class Sim
Bases:
mosaik_api_v3.Simulator
Simulator class for eELib pv_lib model.
- Parameters:
mosaik_api_v3 (module) – defines communication between mosaik and simulator
- init(sid, scenario_config, time_resolution=1.0)
Initializes parameters for an object of the PVLib:Sim class.
- Parameters:
sid (str) – Id of the created instance of the pv_lib simulator (e.g. PVLibSim-0)
scenario_config (dict) – scenario configuration data, like resolution or step size.
time_resolution (float) – Time resolution of current mosaik scenario.
- Returns:
meta description of the simulator
- Return type:
meta
- create(num, model_type, init_vals)
Creates instances of the eELib pv_lib model.
- Parameters:
num (int) – Number of pv_lib models to be created
model_type (str) – Description of the created pv_lib instance
init_vals (list) – List (length=num) with initial values for each pv_lib model
- Returns:
return created entities
- Return type:
dict
- get_entity_by_id(entity_id: str)
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:
object
- step(time, inputs, max_advance)
Performs simulation step calling the eELib pv_lib model. Core function of mosaik.
- Parameters:
time (int) – current simulation time (given by mosaik)
inputs (dict, optional) – allocation of return values to specific models
max_advance (int, optional) – simulation time until the simulator can safely advance it’s internal time without causing any causality errors.
- Raises:
ValueError – Error if more than one set value is tried to be given to entity
TypeError – if value_dict containing set values has an unknown format
- Returns:
next time step (when orchestrator calls again)
- Return type:
int
- get_data(outputs)
Gets the data for the next concatenated model. Core function of mosaik.
- Parameters:
outputs (dict) – Dictionary with data outputs from each pv_lib model
- Raises:
ValueError – Error if attribute not in model metadata
- Returns:
Dictionary with simulation outputs
- Return type:
dict