eelib.data.dataclass.sim_script
Dataclass for sim_script data used in eELib.
Module Contents
Classes
Dataclass for Parameters to configure the simulation/scenario script. |
- class SimScriptConfigParams
Dataclass for Parameters to configure the simulation/scenario script.
Everything has to be inserted as a string to work for the direct save into the scenario script file.
- scenario_name
desired name for this scenario
- Type:
str
- logging_level
level of how much to log into console, options are [“DEBUG”, “INFO”, “WARNING”, “ERROR”, “CRITICAL”, “FATAL”]. Defaults to “WARNING”.
- Type:
str
- start_date
starting date for the simulation. Defaults to “2023-01-01 00:00:00”.
- Type:
str
- end_date
end date for the simulation. Defaults to “2023-02-01 00:00:00”.
- Type:
str
- step_size_in_seconds
granularity of the simulation in seconds. Defaults to “3600”.
- Type:
str
- path_to_database
eelib-internal path to the database. Defaults to “eelib.data.database.hdf5:Hdf5Database”.
- Type:
str
- additional_groups_for_database
Which subgroupings to use in the output DB. Defaults to ‘{“Grid”: [“GridSim”, “GridEMSSim”]}’.
- Type:
str
- use_grid
Whether a grid should be used or not. Defaults to True.
- Type:
bool
- path_to_grid_module
eelib-internal path to the grid module. Defaults to “eelib.core.grid.pandapower.pandapower_simulator:Sim”.
- Type:
str
- name_model_grid
name of the grid model that is used. Defaults to “Pandapower”.
- Type:
str
- use_forecast
Whether to use forecasting in the simulation or not. Defaults to “False”
- Type:
str
- forecast_models_names
Which models have to be connected to the forecast model to retrieve forecasts during the simulation. Defaults to ‘[“hems”, “retailelectricityprovider”]’.
- Type:
str
- path_to_forecast
eelib-internal path to the forecast model. Defaults to “eelib.core.forecast.forecast_simulator:Sim”.
- Type:
str
- name_model_forecast
name of the forecast model that is used. Defaults to “Forecast”.
- Type:
str
- print_progress_during_sim
whether to print the progress during the simulation. Defaults to “True”.
- Type:
str
- plot_mosaik_graphs
whether to plot mosaik simulation graphs after execution. Defaults to “False”.
- Type:
str