edisgo.tools.geopandas_helper
=============================

.. py:module:: edisgo.tools.geopandas_helper


Classes
-------

.. toctree::
   :hidden:

   /autoapi/edisgo/tools/geopandas_helper/GeoPandasGridContainer

.. autoapisummary::

   edisgo.tools.geopandas_helper.GeoPandasGridContainer


Functions
---------

.. autoapisummary::

   edisgo.tools.geopandas_helper.to_geopandas


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

.. py:function:: to_geopandas(grid_obj, srid)

   Translates all DataFrames with geolocations within a grid topology to GeoDataFrames.

   :param grid_obj: Grid or Topology object to transform.
   :type grid_obj: :class:`~.network.grids.Grid` or :class:`~.network.topology.Topology`
   :param srid: SRID (spatial reference ID) of x and y coordinates of buses. Usually given in
                Topology.grid_district["srid"].
   :type srid: int

   :returns: Data container with the grids geo data for all components with information about
             their geolocation.
   :rtype: :class:`.GeoPandasGridContainer`