edisgo.network.dsm.DSM
======================

.. py:class:: edisgo.network.dsm.DSM(**kwargs)

   Data container for demand side management potential data.



   .. py:property:: p_min

      Maximum load decrease in MW.

      :param df: Maximum load decrease in MW. Index of the dataframe is a time index and
                 column names are names of DSM loads as in
                 :attr:`~.network.topology.Topology.loads_df`.
      :type df: :pandas:`pandas.DataFrame<DataFrame>`

      :returns: Maximum load decrease in MW. For more information on the dataframe see
                input parameter `df`.
      :rtype: :pandas:`pandas.DataFrame<DataFrame>`


   .. py:property:: p_max

      Maximum load increase in MW.

      :param df: Maximum load increase in MW. Index of the dataframe is a time index and
                 column names are names of DSM loads as in
                 :attr:`~.network.topology.Topology.loads_df`.
      :type df: :pandas:`pandas.DataFrame<DataFrame>`

      :returns: Maximum load decrease in MW. For more information on the dataframe see
                input parameter `df`.
      :rtype: :pandas:`pandas.DataFrame<DataFrame>`


   .. py:property:: e_min

      Maximum energy preponing in MWh.

      :param df: Maximum energy preponing in MWh. Index of the dataframe is a time index and
                 column names are names of DSM loads as in
                 :attr:`~.network.topology.Topology.loads_df`.
      :type df: :pandas:`pandas.DataFrame<DataFrame>`

      :returns: Maximum energy preponing in MWh. For more information on the dataframe see
                input parameter `df`.
      :rtype: :pandas:`pandas.DataFrame<DataFrame>`


   .. py:property:: e_max

      Maximum energy postponing in MWh.

      :param df: Maximum energy postponing in MWh. Index of the dataframe is a time index and
                 column names are names of DSM loads as in
                 :attr:`~.network.topology.Topology.loads_df`.
      :type df: :pandas:`pandas.DataFrame<DataFrame>`

      :returns: Maximum energy postponing in MWh. For more information on the dataframe see
                input parameter `df`.
      :rtype: :pandas:`pandas.DataFrame<DataFrame>`


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

      Reduces size of dataframes to save memory.

      See :attr:`~.edisgo.EDisGo.reduce_memory` for more information.

      :param attr_to_reduce: List of attributes to reduce size for. Per default, all active
                             and reactive power time series of generators, loads, and storage units
                             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)

      Exports DSM data to csv files.

      The following attributes are exported:

      * 'p_min' : Attribute :py:attr:`~p_min` is saved to `p_min.csv`.
      * 'p_max' : Attribute :py:attr:`~p_max` is saved to `p_max.csv`.
      * 'e_min' : Attribute :py:attr:`~e_min` is saved to `e_min.csv`.
      * 'e_max' : Attribute :py:attr:`~e_max` is saved to `e_max.csv`.

      :param directory: Path to save DSM data to.
      :type directory: str
      :param reduce_memory: If True, size of dataframes is reduced using
                            :attr:`~.network.dsm.DSM.reduce_memory`.
                            Optional parameters of :attr:`~.network.dsm.DSM.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.dsm.DSM.reduce_memory`.



   .. py:method:: from_csv(data_path, from_zip_archive = False)

      Restores DSM data from csv files.

      :param data_path: Path to DSM csv files or zip archive.
      :type data_path: str
      :param from_zip_archive: Set to True if data is archived in a zip archive. Default: False.
      :type from_zip_archive: bool



   .. py:method:: check_integrity()

      Check data integrity.

      Checks for duplicated and missing labels as well as implausible values.