Output Heat to Power Conversion Efficiency

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.7.0
+current_version = 3.7.3
 commit = True
 tag = True
 

.cookiecutterrc

@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.7.0
+    version: 3.7.3
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

CHANGELOG.rst

@@ -12,6 +12,8 @@ GEOPHIRES-X (2023-2025)
 
 "Well depth (or total length, if not vertical)" output field renamed to "Well depth" per https://github.com/NREL/GEOPHIRES-X/issues/321
 
+3.7.3: Heat to Power Conversion Efficiency output added.
+
 
 3.6
 ^^^

README.rst

@@ -56,9 +56,9 @@ Free software: `MIT license <LICENSE>`__
     :alt: Supported implementations
     :target: https://pypi.org/project/geophires-x
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.7.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.7.3.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.7.0...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.7.3...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X

docs/conf.py

@@ -18,7 +18,7 @@
 year = '2024'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.7.0'
+version = release = '3.7.3'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.7.0',
+    version='3.7.3',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(

src/geophires_x/Outputs.py

@@ -23,7 +23,6 @@
     PlantType
 from geophires_x.GeoPHIRESUtils import UpgradeSymbologyOfUnits, render_default, InsertImagesIntoHTML
 from geophires_x.Parameter import Parameter
-from geophires_x.Units import convertible_unit, Units, PercentUnit
 
 NL = '\n'
 validFilenameChars = "-_.() %s%s" % (string.ascii_letters, string.digits)
@@ -1912,6 +1911,11 @@ def PrintOutputs(self, model: Model):
 
                 f.write(f'      Average Pumping Power:                            {np.average(model.wellbores.PumpingPower.value):10.2f} {model.wellbores.PumpingPower.CurrentUnits.value}{NL}')
 
+                if model.surfaceplant.heat_to_power_conversion_efficiency.value is not None:
+                    hpce = model.surfaceplant.heat_to_power_conversion_efficiency
+                    f.write(f'      {Outputs._field_label(hpce.Name, 50)}'
+                            f'{hpce.value:10.2f} {model.surfaceplant.heat_to_power_conversion_efficiency.CurrentUnits.value}\n')
+
                 f.write(NL)
                 f.write('                            ************************************************************\n')
                 f.write('                            *  HEATING, COOLING AND/OR ELECTRICITY PRODUCTION PROFILE  *\n')

src/geophires_x/Parameter.py

@@ -63,8 +63,8 @@ class OutputParameter(HasQuantity):
     """
 
     Name: str = ""
-    value: int = 0
-    ToolTipText: str = "This is ToolTip Text"
+    value: Any = 0
+    ToolTipText: str = ""
     UnitType: IntEnum = Units.NONE
     PreferredUnits: Enum = Units.NONE
     # set to PreferredUnits by default assuming that the current units are the preferred units -

src/geophires_x/SurfacePlant.py

@@ -2,6 +2,7 @@
 import os
 import numpy as np
 
+from .GeoPHIRESUtils import quantity
 from .OptionList import EndUseOptions, PlantType
 from .Parameter import floatParameter, intParameter, strParameter, OutputParameter, ReadParameter, \
     coerce_int_params_to_enum_values
@@ -486,7 +487,16 @@ def __init__(self, model: Model):
             Name="First Law Efficiency",
             UnitType=Units.PERCENT,
             PreferredUnits=PercentUnit.PERCENT,
-            CurrentUnits=PercentUnit.PERCENT
+            CurrentUnits=PercentUnit.PERCENT,  # FIXME default values are actually in tenths, not percent.
+            ToolTipText='Net electricity produced divided by heat extracted towards electricity'
+        )
+        self.heat_to_power_conversion_efficiency = self.OutputParameterDict[self.heat_to_power_conversion_efficiency.Name] = OutputParameter(
+            Name='Heat to Power Conversion Efficiency',
+            value=None,
+            UnitType=Units.PERCENT,
+            PreferredUnits=PercentUnit.PERCENT,
+            CurrentUnits=PercentUnit.PERCENT,
+            ToolTipText='First law efficiency average over project lifetime'
         )
         self.HeatExtracted = self.OutputParameterDict[self.HeatExtracted.Name] = OutputParameter(
             Name="Heat Extracted",
@@ -636,4 +646,20 @@ def Calculate(self, model: Model) -> None:
 
         # All calculations are handled in subclasses of this class, so this function is empty.
 
+        # Subclasses should call _calculate_derived_outputs at the end of their Calculate methods.
+        self._calculate_derived_outputs(model)
+
         model.logger.info(f'Complete {self.__class__.__name__}: {__name__}')
+
+    def _calculate_derived_outputs(self, model: Model) -> None:
+        """
+        Subclasses should call _calculate_derived_outputs at the end of their Calculate methods to populate output
+        values that are derived from subclass-calculated outputs.
+        """
+
+        if self.FirstLawEfficiency is not None:
+            fle_unit = PercentUnit.TENTH  # See FIXME on self.FirstLawEfficiency re: CurrentUnit being incorrect.
+            avg_efficiency = quantity(np.average(model.surfaceplant.FirstLawEfficiency.value), fle_unit).to(
+                convertible_unit(self.heat_to_power_conversion_efficiency.CurrentUnits)).magnitude
+            if avg_efficiency > 0:  # 0 is presumed to mean N/A
+                self.heat_to_power_conversion_efficiency.value = avg_efficiency

src/geophires_x/SurfacePlantAGS.py

@@ -783,4 +783,5 @@ def Calculate(self, model: Model) -> None:
             print(f'Error: {class_file_info_msg}. Exiting....')
             raise RuntimeError(base_msg)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f"complete {str(__class__)}: {sys._getframe().f_code.co_name}")

src/geophires_x/SurfacePlantAbsorptionChiller.py

@@ -141,4 +141,6 @@ def Calculate(self, model: Model) -> None:
         # calculate reservoir heat content
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
+
+        self._calculate_derived_outputs(model)
         model.logger.info(f"complete {self.__class__.__name__}: {__name__}")

src/geophires_x/SurfacePlantDistrictHeating.py

@@ -249,6 +249,7 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f"Complete {self.__class__.__name__}: {__name__}")
 
     # district heating routines below

src/geophires_x/SurfacePlantDoubleFlash.py

@@ -133,4 +133,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f'complete {self.__class__.__name__}: {__name__}')

src/geophires_x/SurfacePlantHeatPump.py

@@ -131,4 +131,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + str(__class__) + ": " + inspect.currentframe().f_code.co_name)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {str(__class__)}: {inspect.currentframe().f_code.co_name}")

src/geophires_x/SurfacePlantIndustrialHeat.py

@@ -98,4 +98,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + self.__class__.__name__ + ": " + __name__)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {self.__class__.__name__}: {__name__}")

src/geophires_x/SurfacePlantSUTRA.py

@@ -204,5 +204,6 @@ def Calculate(self, model: Model) -> None:
         # calculate maximum auxiliary boiler demand
         self.max_peaking_boiler_demand.value = max(self.AnnualAuxiliaryHeatProduced.value)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f"complete {self.__class__.__name__}: {self.__init__.__name__}")
 

src/geophires_x/SurfacePlantSingleFlash.py

@@ -122,7 +122,7 @@ def Calculate(self, model: Model) -> None:
         self.NetElectricityProduced.value = self.ElectricityProduced.value - model.wellbores.PumpingPower.value
         self.FirstLawEfficiency.value = self.NetElectricityProduced.value/HeatExtractedTowardsElectricity
 
-        # Calculate annual electricity, pum;ping, and heat production
+        # Calculate annual electricity, pumping, and heat production
         self.HeatkWhExtracted.value, self.PumpingkWh.value, self.TotalkWhProduced.value, self.NetkWhProduced.value, self.HeatkWhProduced.value = \
         SurfacePlant.annual_electricity_pumping_power(self, self.plant_lifetime.value, self.enduse_option.value,
                                 self.HeatExtracted.value, model.economics.timestepsperyear.value, self.utilization_factor.value,
@@ -133,4 +133,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {str(__class__)}: {sys._getframe().f_code.co_name}")

src/geophires_x/SurfacePlantSubcriticalORC.py

@@ -131,4 +131,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + self.__class__.__name__ + ": " + __name__)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {self.__class__.__name__}: {__name__}")

src/geophires_x/SurfacePlantSupercriticalORC.py

@@ -130,4 +130,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + self.__class__.__name__ + ": " + __name__)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {self.__class__.__name__}: {__name__}")

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.7.0'
+__version__ = '3.7.3'

src/geophires_x_client/geophires_x_result.py

@@ -277,9 +277,10 @@ class GeophiresXResult:
                 'Maximum Peaking Boiler Heat Production',
                 'Average Peaking Boiler Heat Production',
                 'Minimum Peaking Boiler Heat Production',
+                'Initial pumping power/net installed power',
+                'Heat to Power Conversion Efficiency',
                 # AGS/CLGS
                 'Surface Plant Cost',
-                'Initial pumping power/net installed power',
                 # SUTRA
                 'Average RTES Heating Production',
                 'Average Auxiliary Heating Production',

src/geophires_x_schema_generator/__init__.py

@@ -112,7 +112,7 @@ def generate_json_schema(self) -> dict:
                 'type': param['json_parameter_type'],
                 'units': units_val,
                 'category': param['parameter_category'],
-                'default': param['DefaultValue'],
+                'default': _fix_floating_point_error(param['DefaultValue']),
                 'minimum': min_val,
                 'maximum': max_val,
             }
@@ -168,13 +168,15 @@ def get_input_params_table(category_params, category_name) -> str:
                 # if param['Required']:
                 #     TODO designate required params
 
+                default_value = _fix_floating_point_error(_get_key(param, 'DefaultValue'))
+
                 min_val, max_val = _get_min_and_max(param)
 
                 input_rst += f"""\n       * - {param['Name']}
          - {_get_key(param, 'ToolTipText')}
          - {_get_key(param, 'PreferredUnits')}
          - {_get_key(param, 'json_parameter_type')}
-         - {_get_key(param, 'DefaultValue')}
+         - {default_value}
          - {min_val}
          - {max_val}"""
 
@@ -210,6 +212,7 @@ def get_output_params_table_rst(self, output_params_json) -> str:
        :header-rows: 1
 
        * - Name
+         - Description
          - Preferred Units
          - Default Value Type"""
 
@@ -223,6 +226,7 @@ def get_key(k):
                     return ''
 
             output_rst += f"""\n       * - {param['Name']}
+         - {get_key('ToolTipText')}
          - {get_key('PreferredUnits')}
          - {get_key('json_parameter_type')}"""
 
@@ -245,7 +249,14 @@ def _get_min_and_max(param: dict, default_val='') -> Tuple:
         min_val = min(param['AllowableRange'])
         max_val = max(param['AllowableRange'])
 
-    return (min_val, max_val)
+    return _fix_floating_point_error(min_val), _fix_floating_point_error(max_val)
+
+
+def _fix_floating_point_error(val: Any) -> Any:
+    if '.0000' in str(val):
+        return format(float(val), '.1f')
+
+    return val
 
 
 class HipRaXSchemaGenerator(GeophiresXSchemaGenerator):

src/geophires_x_schema_generator/geophires-request.json

@@ -726,7 +726,7 @@
       "category": "Well Bores",
       "default": 1.0,
       "minimum": 0.0,
-      "maximum": 1.000001
+      "maximum": "1.0"
     },
     "Is AGS": {
       "description": "Set to true if the model is for an Advanced Geothermal System (AGS)",
@@ -2086,7 +2086,7 @@
       "type": "number",
       "units": "%",
       "category": "Economics",
-      "default": 7.00,
+      "default": "7.0",
       "minimum": 0.0,
       "maximum": 100.0
     },

tests/example1_addons.csv

@@ -98,7 +98,8 @@ SURFACE EQUIPMENT SIMULATION RESULTS,Average Annual Total Electricity Generation
 SURFACE EQUIPMENT SIMULATION RESULTS,Average Annual Net Electricity Generation,,42.3,GWh
 SURFACE EQUIPMENT SIMULATION RESULTS,Average Pumping Power,,0.2,MW
 SURFACE EQUIPMENT SIMULATION RESULTS,Initial pumping power/net installed power,,3.82,%
-Simulation Metadata,GEOPHIRES Version,,3.7.0,
+SURFACE EQUIPMENT SIMULATION RESULTS,Heat to Power Conversion Efficiency,,10.07,%
+Simulation Metadata,GEOPHIRES Version,,3.7.1,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,1,1.0,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,2,1.0056,
 POWER GENERATION PROFILE,THERMAL DRAWDOWN,3,1.0073,

tests/examples/Fervo_Norbeck_Latimer_2023.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.7.0
- Simulation Date: 2025-01-20
- Simulation Time:  10:49
- Calculation Time:      0.454 sec
+ GEOPHIRES Version: 3.7.1
+ Simulation Date: 2025-01-22
+ Simulation Time:  10:48
+ Calculation Time:      0.443 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -129,6 +129,7 @@ Simulation Metadata
       Average Annual Net Electricity Generation:             17.70 GWh
       Initial pumping power/net installed power:             28.16 %
       Average Pumping Power:                                  0.63 MW
+      Heat to Power Conversion Efficiency:                    9.95 %
 
                             ************************************************************
                             *  HEATING, COOLING AND/OR ELECTRICITY PRODUCTION PROFILE  *

tests/examples/Fervo_Project_Cape-2.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.7.0
- Simulation Date: 2025-01-20
- Simulation Time:  10:49
- Calculation Time:      0.685 sec
+ GEOPHIRES Version: 3.7.1
+ Simulation Date: 2025-01-22
+ Simulation Time:  10:48
+ Calculation Time:      0.684 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -127,6 +127,7 @@ Simulation Metadata
       Average Annual Net Electricity Generation:             69.67 GWh
       Initial pumping power/net installed power:              1.68 %
       Average Pumping Power:                                  0.15 MW
+      Heat to Power Conversion Efficiency:                   16.00 %
 
                             ************************************************************
                             *  HEATING, COOLING AND/OR ELECTRICITY PRODUCTION PROFILE  *

tests/examples/Fervo_Project_Cape-3.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.7.0
- Simulation Date: 2025-01-20
- Simulation Time:  10:49
- Calculation Time:      0.915 sec
+ GEOPHIRES Version: 3.7.1
+ Simulation Date: 2025-01-22
+ Simulation Time:  10:48
+ Calculation Time:      0.889 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -128,6 +128,7 @@ Simulation Metadata
       Average Annual Net Electricity Generation:           3171.75 GWh
       Initial pumping power/net installed power:             13.50 %
       Average Pumping Power:                                 53.73 MW
+      Heat to Power Conversion Efficiency:                   14.39 %
 
                             ************************************************************
                             *  HEATING, COOLING AND/OR ELECTRICITY PRODUCTION PROFILE  *