edisgo.network.overlying_grid.OverlyingGrid
===========================================

.. py:class:: edisgo.network.overlying_grid.OverlyingGrid(**kwargs)

   Data container for requirements from the overlying grid.

   The requirements from the overlying grid are used as constraints for flexibilities.

   .. attribute:: renewables_curtailment

      Curtailment of fluctuating renewables per time step in MW.

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: storage_units_active_power

      Aggregated dispatch of storage units per time step in MW.

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: storage_units_soc

      State of charge of storage units per time step in p.u.. The state of charge at
      time step t here constitutes the state of charge at the beginning of time step
      t.

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: dsm_active_power

      Aggregated demand side management utilisation per time step in MW.

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: electromobility_active_power

      Aggregated charging demand at all charging sites in grid per time step in MW.

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: heat_pump_decentral_active_power

      Aggregated demand of flexible decentral heat pumps per time step in MW.

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: thermal_storage_units_decentral_soc

      State of charge of decentral thermal storage units in p.u..

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: heat_pump_central_active_power

      Aggregated demand of flexible central heat pumps per time step in MW.

      :type: :pandas:`pandas.Series<Series>`

   .. attribute:: thermal_storage_units_central_soc

      State of charge of central thermal storage units per district heating area (in
      columns as string of integer, i.e. "130" instead of "130.0") and time step
      (in index) in p.u.. The state of charge at time step t here constitutes the
      state of charge at the beginning of time step t.

      :type: :pandas:`pandas.DataFrame<DataFrame>`

   .. attribute:: feedin_district_heating

      Other thermal feed-in into district heating per district heating area (in
      columns as string of integer, i.e. "130" instead of "130.0") and time step
      (in index) in MW.

      :type: :pandas:`pandas.DataFrame<DataFrame>`


   .. py:attribute:: renewables_curtailment


   .. py:attribute:: storage_units_active_power


   .. py:attribute:: storage_units_soc


   .. py:attribute:: dsm_active_power


   .. py:attribute:: electromobility_active_power


   .. py:attribute:: heat_pump_decentral_active_power


   .. py:attribute:: thermal_storage_units_decentral_soc


   .. py:attribute:: heat_pump_central_active_power


   .. py:attribute:: thermal_storage_units_central_soc


   .. py:attribute:: feedin_district_heating


   .. py:method:: reduce_memory(attr_to_reduce=None, to_type='float32')

      Reduces size of time series data to save memory.

      :param attr_to_reduce: List of attributes to reduce size for. Per default, all time series data
                             are reduced.
      :type attr_to_reduce: list(str), optional
      :param to_type: Data type to convert time series data to. This is a tradeoff
                      between precision and memory. Default: "float32".
      :type to_type: str, optional



   .. py:method:: to_csv(directory, reduce_memory=False, **kwargs)

      Saves data in object to csv.

      :param directory: Directory to save data in.
      :type directory: str
      :param reduce_memory: If True, size of time series data is reduced using
                            :attr:`~.network.overlying_grid.OverlyingGrid.reduce_memory`.
                            Optional parameters of
                            :attr:`~.network.overlying_grid.OverlyingGrid.reduce_memory`
                            can be passed as kwargs to this function. Default: False.
      :type reduce_memory: bool, optional

      :param kwargs: Kwargs may contain arguments of
                     :attr:`~.network.overlying_grid.OverlyingGrid.reduce_memory`.



   .. py:method:: from_csv(data_path, dtype=None, from_zip_archive=False, **kwargs)

      Restores data in object from csv files.

      :param data_path: Path to directory to obtain data from. Must be a directory or zip
                        archive.
      :type data_path: str
      :param dtype: Numerical data type for data to be loaded from csv. E.g. "float32".
                    Default: None.
      :type dtype: str, optional
      :param from_zip_archive: Set True if data is archived in a zip archive. Default: False.
      :type from_zip_archive: bool, optional



   .. py:method:: resample(method = 'ffill', freq = '15min')

      Resamples all time series to a desired resolution.

      See :attr:`~.EDisGo.resample_timeseries` for more information.

      :param method: See :attr:`~.EDisGo.resample_timeseries` for more information.
      :type method: str, optional
      :param freq: See :attr:`~.EDisGo.resample_timeseries` for more information.
      :type freq: str, optional