:py:mod:`eelib.utils.simulation_setup.helper_create_sim`
========================================================

.. py:module:: eelib.utils.simulation_setup.helper_create_sim

.. autoapi-nested-parse::

   Helper functions for the generation of new simulations.

   | 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
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   eelib.utils.simulation_setup.helper_create_sim.create_excel_for_models
   eelib.utils.simulation_setup.helper_create_sim.read_excel_for_models
   eelib.utils.simulation_setup.helper_create_sim.create_excel_for_same_models
   eelib.utils.simulation_setup.helper_create_sim.read_excel_for_same_models
   eelib.utils.simulation_setup.helper_create_sim.create_model_data_file
   eelib.utils.simulation_setup.helper_create_sim.create_grid_model_config_file



.. py:function:: create_excel_for_models(models_dict: dict, bool_same_models: bool = False)

   Create excel with sheets for all existing models and their parameters.

   :param models_dict: info about existing models and their parameters
   :type models_dict: dict
   :param bool_same_models: if models can have all the same entities. Defaults to False.
   :type bool_same_models: bool


.. py:function:: read_excel_for_models(models_dict: dict) -> dict

   Create dict of model data from information in excel on all model types.

   :param models_dict: info about existing models and their parameters
   :type models_dict: dict

   :returns: info on all models/entities for the simulation
   :rtype: dict


.. py:function:: create_excel_for_same_models(model_data: dict)

   Create excel with sheets for all named models with 1 entity to possibly multiply them.

   :param model_data: info on models for the simulation
   :type model_data: dict


.. py:function:: read_excel_for_same_models(model_data: dict) -> dict

   Create dict of model data from existent data and information on same models at loadbuses.

   :param model_data: info on models for the simulation
   :type model_data: dict

   :returns: info on all entities for the simulation
   :rtype: dict


.. py:function:: create_model_data_file(model_data: dict, model_data_path='model_data.json')

   Create model data file with information on all model parameterizations.

   :param model_data: info on all entities for the simulation
   :type model_data: dict
   :param model_data_path: path to store model data file. Defaults to "model_data.json".
   :type model_data_path: str


.. py:function:: create_grid_model_config_file(model_data: dict, config_path: str = 'grid_model_config.json')

   Create connection file for grid simulations with entities at specific load buses.

   :param model_data: info on all entities for the simulation and their loadbuses
   :type model_data: dict
   :param config_path: path to store config file. Defaults to "grid_model_config.json".
   :type config_path: str