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

.. py:module:: eelib.utils.simulation_setup.helper_create_grid

.. 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_grid.create_excel_for_grid
   eelib.utils.simulation_setup.helper_create_grid.read_excel_for_grid
   eelib.utils.simulation_setup.helper_create_grid.create_grid_file_with_name
   eelib.utils.simulation_setup.helper_create_grid.create_grid_file



Attributes
~~~~~~~~~~

.. autoapisummary::

   eelib.utils.simulation_setup.helper_create_grid.bus_fields
   eelib.utils.simulation_setup.helper_create_grid.load_fields
   eelib.utils.simulation_setup.helper_create_grid.ext_grid_fields
   eelib.utils.simulation_setup.helper_create_grid.trafo_fields
   eelib.utils.simulation_setup.helper_create_grid.line_fields
   eelib.utils.simulation_setup.helper_create_grid.grid


.. py:data:: bus_fields
   :value: ['index', 'vn_kv', 'name', 'in_service', 'geodata']

   

.. py:data:: load_fields
   :value: ['bus', 'name', 'scaling']

   

.. py:data:: ext_grid_fields
   :value: ['bus', 'name', 'in_service']

   

.. py:data:: trafo_fields
   :value: ['hv_bus', 'lv_bus', 'std_type', 'name', 'in_service', 'parallel']

   

.. py:data:: line_fields
   :value: ['from_bus', 'to_bus', 'name', 'in_service', 'length_km', 'std_type', 'parallel']

   

.. py:data:: grid

   

.. py:function:: create_excel_for_grid()

   Create an empty excel fill to fill with information on grid components.


.. py:function:: read_excel_for_grid() -> dict

   Read information on grid components from excel file and save into dict.

   :returns: Information on all grid components
   :rtype: dict


.. py:function:: create_grid_file_with_name(pp_grid_name: str = 'create_kerber_landnetz_kabel_1', grid_path: str = 'grid.json', adjust_comp_names: bool = True, plot_grid: bool = False)

   Create pandapower grid including saved json file from information about pandapower template.

   :param pp_grid_name: PP method for grid. Defaults to "create_kerber_landnetz_kabel_1".
   :type pp_grid_name: str
   :param grid_path: path to save json file to. Defaults to "grid.json".
   :type grid_path: str
   :param adjust_comp_names: whether to adjust component names if None. Defaults to True.
   :type adjust_comp_names: bool
   :param plot_grid: whether to create simple plot of grid. Defaults to False.
   :type plot_grid: bool

   :returns: _description_
   :rtype: _type_


.. py:function:: create_grid_file(grid_data: dict, grid_path: str = 'grid.json', plot_grid: bool = False) -> object

   Create pandapower grid including saved json file from information about grid components.

   :param grid_data: information on all grid components
   :type grid_data: dict
   :param grid_path: path to save json file to. Defaults to "grid.json".
   :type grid_path: str
   :param plot_grid: whether to create simple plot of grid. Defaults to False.
   :type plot_grid: bool

   :returns: pandapower grid object
   :rtype: object