edisgo.io.heat_pump_import
==========================

.. py:module:: edisgo.io.heat_pump_import


Functions
---------

.. autoapisummary::

   edisgo.io.heat_pump_import.oedb
   edisgo.io.heat_pump_import.efficiency_resistive_heaters_oedb


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

.. py:function:: oedb(edisgo_object, scenario, engine, import_types=None)

   Gets heat pumps for specified scenario from oedb and integrates them into the grid.

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

   :param edisgo_object:
   :type edisgo_object: :class:`~.EDisGo`
   :param scenario: Scenario for which to retrieve heat pump data. Possible options
                    are "eGon2035" and "eGon100RE".
   :type scenario: str
   :param engine: Database engine.
   :type engine: :sqlalchemy:`sqlalchemy.Engine<sqlalchemy.engine.Engine>`
   :param import_types: Specifies which technologies to import. Possible options are
                        "individual_heat_pumps", "central_heat_pumps" and "central_resistive_heaters".
                        If None, all are imported.
   :type import_types: list(str) or None

   :returns: List with names (as in index of :attr:`~.network.topology.Topology.loads_df`)
             of integrated heat pumps.
   :rtype: list(str)


.. py:function:: efficiency_resistive_heaters_oedb(scenario, engine)

   Get efficiency of resistive heaters from the
   `OpenEnergy DataBase <https://openenergyplatform.org/database/>`_.

   :param scenario: Scenario for which to retrieve efficiency data. Possible options
                    are "eGon2035" and "eGon100RE".
   :type scenario: str
   :param engine: Database engine.
   :type engine: :sqlalchemy:`sqlalchemy.Engine<sqlalchemy.engine.Engine>`

   :returns: Dictionary with efficiency of resistive heaters in district and individual
             heating. Keys of the dictionary are
             "central_resistive_heater" giving the efficiency of resistive heaters in
             district heating and "rural_resistive_heater" giving the efficiency of
             resistive heaters in individual heating systems. Values are of type float and
             given in p.u.
   :rtype: dict