edisgo.tools.pseudo_coordinates
===============================

.. py:module:: edisgo.tools.pseudo_coordinates


Functions
---------

.. autoapisummary::

   edisgo.tools.pseudo_coordinates.make_pseudo_coordinates_graph
   edisgo.tools.pseudo_coordinates.make_pseudo_coordinates


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

.. py:function:: make_pseudo_coordinates_graph(G, branch_detour_factor)

   Generates pseudo coordinates for one graph.

   :param G: Graph object to generate pseudo coordinates for.
   :type G: :networkx:`networkx.Graph<>`
   :param branch_detour_factor: Defines the quotient of the line length and the distance of the buses.
   :type branch_detour_factor: float

   :returns: Graph with pseudo coordinates for all nodes.
   :rtype: :networkx:`networkx.Graph<>`


.. py:function:: make_pseudo_coordinates(edisgo_obj, mv_coordinates = False)

   Generates pseudo coordinates for all LV grids and optionally MV grid.

   Bus coordinates are changed in the Topology object directly. If you want to keep
   information on the original coordinates, hand a copy of the EDisGo object to this
   function.

   :param edisgo_obj: eDisGo object to create pseudo coordinates for.
   :type edisgo_obj: :class:`~.EDisGo`
   :param mv_coordinates: If False, pseudo coordinates are only generated for LV buses. If True, pseudo
                          coordinates are as well generated for MV buses.
                          Default: False.
   :type mv_coordinates: bool, optional