edisgo.tools.networkx_helper
============================

.. py:module:: edisgo.tools.networkx_helper


Functions
---------

.. autoapisummary::

   edisgo.tools.networkx_helper.translate_df_to_graph


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

.. py:function:: translate_df_to_graph(buses_df, lines_df, transformers_df = None)

   Translate DataFrames to networkx Graph Object.

   :param buses_df: Dataframe with all buses to use as Graph nodes. For more information about the
                    Dataframe see :attr:`~.network.topology.Topology.buses_df`.
   :type buses_df: :pandas:`pandas.DataFrame<DataFrame>`
   :param lines_df: Dataframe with all lines to use as Graph branches. For more information about
                    the Dataframe see :attr:`~.network.topology.Topology.lines_df`
   :type lines_df: :pandas:`pandas.DataFrame<DataFrame>`
   :param transformers_df: Dataframe with all transformers to use as additional Graph nodes. For more
                           information about the Dataframe see
                           :attr:`~.network.topology.Topology.transformers_df`
   :type transformers_df: :pandas:`pandas.DataFrame<DataFrame>`, optional

   :returns: Graph representation of the grid as networkx Ordered Graph,
             where lines are represented by edges in the graph, and buses and
             transformers are represented by nodes.
   :rtype: :networkx:`networkx.Graph<>`