reskit.geothermal
=================

.. py:module:: reskit.geothermal


Submodules
----------

.. toctree::
   :maxdepth: 1

   /_readthedocs/reskit/geothermal/data/index
   /_readthedocs/reskit/geothermal/workflows/index


Functions
---------

.. autoapisummary::

   reskit.geothermal.EGSworkflow


Package Contents
----------------

.. py:function:: EGSworkflow(placements, sourceTemperature=path_temperatures, sourceSustainableHeatflow=path_heat_flow_sustainable_W_per_m2, savepath=None, configuration='doublette', manual_values={})

   Executes the Enhanced Geothermal System (EGS) workflow for given placements.

   :param placements (pd.DataFrame):
   :type placements (pd.DataFrame): Locations where the EGS workflow will be applied. Needs to have lat lon and geokit geoms.
   :param sourceTemperature (str or Path: Defaults to `path_temperatures`.
   :type sourceTemperature (str or Path: Path to the geothermal temperature data.
   :param optional): Defaults to `path_temperatures`.
   :type optional): Path to the geothermal temperature data.
   :param sourceSustainableHeatflow (str or Path: Defaults to `path_heat_flow_sustainable_W_per_m2`.
   :type sourceSustainableHeatflow (str or Path: Path to the sustainable heat flow data.
   :param optional): Defaults to `path_heat_flow_sustainable_W_per_m2`.
   :type optional): Path to the sustainable heat flow data.
   :param savepath (str or Path:
   :type savepath (str or Path: Directory where results will be saved. Defaults to None which outputs the data.
   :param optional):
   :type optional): Directory where results will be saved. Defaults to None which outputs the data.
   :param configuration (str: Defaults to 'doublette'.
   :type configuration (str: Type of geothermal system configuration.
   :param optional): Defaults to 'doublette'.
   :type optional): Type of geothermal system configuration.
   :param manual_values (dict:
   :type manual_values (dict: Dictionary of manually specified values for overriding defaults.
   :param optional):
   :type optional): Dictionary of manually specified values for overriding defaults.

   :returns: **None or xarray object**
   :rtype: Workflow results, optionally saved to `savepath`.

   Citation:
        Franzmann, David and Heinrichs, Heidi and Stolten, Detlef, Global Electricity Potentials
        from Geothermal Power Under Technical, Economic, Sustainable Evaluation. Available at SSRN:
        https://ssrn.com/abstract=5029989 or http://dx.doi.org/10.2139/ssrn.5029989