edisgo.network.grids.LVGrid
===========================

.. py:class:: edisgo.network.grids.LVGrid(**kwargs)

   Bases: :py:obj:`Grid`

   .. autoapi-inheritance-diagram:: edisgo.network.grids.LVGrid
      :parts: 1


   Defines a low voltage network in eDisGo.



   .. py:property:: buses_df

      Buses within the network.

      :returns: Dataframe with all buses in topology. For more information on the
                dataframe see :attr:`~.network.topology.Topology.buses_df`.
      :rtype: :pandas:`pandas.DataFrame<DataFrame>`


   .. py:property:: transformers_df

      Transformers to overlaying network.

      :returns: Dataframe with all transformers to overlaying network. For more
                information on the dataframe see
                :attr:`~.network.topology.Topology.transformers_df`.
      :rtype: :pandas:`pandas.DataFrame<DataFrame>`


   .. py:method:: draw(node_color='black', edge_color='black', colorbar=False, labels=False, filename=None)

      Draw LV network.

      Currently, edge width is proportional to nominal apparent power of
      the line and node size is proportional to peak load of connected loads.

      :param node_color: Color of the nodes (buses) of the grid. If provided as string
                         all nodes will have that color. If provided as series, the
                         index of the series must contain all buses in the LV grid and the
                         corresponding values must be float values, that will be translated
                         to the node color using a colormap, currently set to "Blues".
                         Default: "black".
      :type node_color: str or :pandas:`pandas.Series<Series>`
      :param edge_color: Color of the edges (lines) of the grid. If provided as string
                         all edges will have that color. If provided as series, the
                         index of the series must contain all lines in the LV grid and the
                         corresponding values must be float values, that will be translated
                         to the edge color using a colormap, currently set to "inferno_r".
                         Default: "black".
      :type edge_color: str or :pandas:`pandas.Series<Series>`
      :param colorbar: If True, a colorbar is added to the plot for node and edge colors,
                       in case these are sequences. Default: False.
      :type colorbar: bool
      :param labels: If True, displays bus names. As bus names are quite long, this
                     is currently not very pretty. Default: False.
      :type labels: bool
      :param filename: If a filename is provided, the plot is saved under that name but
                       not displayed. If no filename is provided, the plot is only
                       displayed. Default: None.
      :type filename: str or None