:py:mod:`eelib.data.dataclass.sim_script`
=========================================

.. py:module:: eelib.data.dataclass.sim_script

.. autoapi-nested-parse::

   Dataclass for sim_script data used in eELib.

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



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   eelib.data.dataclass.sim_script.SimScriptConfigParams




.. py: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.

   .. attribute:: scenario_name

      desired name for this scenario

      :type: str

   .. attribute:: logging_level

      level of how much to log into console, options are ["DEBUG", "INFO",
      "WARNING", "ERROR", "CRITICAL", "FATAL"]. Defaults to "WARNING".

      :type: str

   .. attribute:: start_date

      starting date for the simulation. Defaults to "2023-01-01 00:00:00".

      :type: str

   .. attribute:: end_date

      end date for the simulation. Defaults to "2023-02-01 00:00:00".

      :type: str

   .. attribute:: step_size_in_seconds

      granularity of the simulation in seconds. Defaults to "3600".

      :type: str

   .. attribute:: path_to_database

      eelib-internal path to the database. Defaults to
      "eelib.data.database.hdf5:Hdf5Database".

      :type: str

   .. attribute:: additional_groups_for_database

      Which subgroupings to use in the output DB.
      Defaults to '{"Grid": ["GridSim", "GridEMSSim"]}'.

      :type: str

   .. attribute:: use_grid

      Whether a grid should be used or not. Defaults to True.

      :type: bool

   .. attribute:: path_to_grid_module

      eelib-internal path to the grid module. Defaults to
      "eelib.core.grid.pandapower.pandapower_simulator:Sim".

      :type: str

   .. attribute:: name_model_grid

      name of the grid model that is used. Defaults to "Pandapower".

      :type: str

   .. attribute:: use_forecast

      Whether to use forecasting in the simulation or not. Defaults to "False"

      :type: str

   .. attribute:: 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

   .. attribute:: path_to_forecast

      eelib-internal path to the forecast model. Defaults to
      "eelib.core.forecast.forecast_simulator:Sim".

      :type: str

   .. attribute:: name_model_forecast

      name of the forecast model that is used. Defaults to "Forecast".

      :type: str

   .. attribute:: print_progress_during_sim

      whether to print the progress during the simulation.
      Defaults to "True".

      :type: str

   .. attribute:: plot_mosaik_graphs

      whether to plot mosaik simulation graphs after execution. Defaults
      to "False".

      :type: str