Merge branch 'NREL:main' into main

malcolm-dsider · web-flow · commit 4c6dc0e8f7fa · 2024-04-16T13:09:32.000-05:00
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.4.24
+current_version = 3.4.25
 commit = True
 tag = True
 
diff --git a/.cookiecutterrc b/.cookiecutterrc
@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.4.24
+    version: 3.4.25
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"
diff --git a/README.rst b/README.rst
@@ -47,9 +47,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.4.24.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.25.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.24...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.25...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 year = '2023'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.4.24'
+version = release = '3.4.25'
 
 pygments_style = 'trac'
 templates_path = ['./templates']
diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.4.24',
+    version='3.4.25',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(
diff --git a/src/geophires_x/Outputs.py b/src/geophires_x/Outputs.py
@@ -1516,7 +1516,8 @@ def PrintOutputs(self, model: Model):
                 f.write('                           ***SUMMARY OF RESULTS***\n')
                 f.write(NL)
                 f.write('      End-Use Option: ' + str(model.surfaceplant.enduse_option.value.value) + NL)
-
+                if model.surfaceplant.plant_type.value in [PlantType.ABSORPTION_CHILLER, PlantType.HEAT_PUMP, PlantType.DISTRICT_HEATING]:
+                    f.write('      Surface Application: ' + str(model.surfaceplant.plant_type.value.value) + NL)
                 if model.surfaceplant.enduse_option.value in [EndUseOptions.ELECTRICITY, EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICITY]: # there is an electricity component
                     f.write(f'      Average Net Electricity Production:               {np.average(model.surfaceplant.NetElectricityProduced.value):10.2f} ' + model.surfaceplant.NetElectricityProduced.CurrentUnits.value + NL)
                 if model.surfaceplant.enduse_option.value != EndUseOptions.ELECTRICITY:    # there is a direct-use component
diff --git a/src/geophires_x/__init__.py b/src/geophires_x/__init__.py
@@ -1 +1 @@
-__version__ = '3.4.24'
+__version__ = '3.4.25'
diff --git a/src/geophires_x_client/geophires_x_result.py b/src/geophires_x_client/geophires_x_result.py
@@ -27,6 +27,7 @@ class GeophiresXResult:
             'SUMMARY OF RESULTS': [
                 _StringValueField('End-Use Option'),
                 _StringValueField('End-Use'),
+                _StringValueField('Surface Application'),
                 'Average Net Electricity Production',
                 'Electricity breakeven price',
                 'Average Direct-Use Heat Production',
diff --git a/tests/examples/example10_HP.out b/tests/examples/example10_HP.out
@@ -13,6 +13,7 @@ Simulation Metadata
                            ***SUMMARY OF RESULTS***
 
       End-Use Option: Direct-Use Heat
+      Surface Application: Heat Pump
       Average Direct-Use Heat Production:                    16.64 MW
       Direct-Use heat breakeven price (LCOH):                 14.49 USD/MMBTU
       Number of production wells:                             2
diff --git a/tests/examples/example11_AC.out b/tests/examples/example11_AC.out
@@ -13,6 +13,7 @@ Simulation Metadata
                            ***SUMMARY OF RESULTS***
 
       End-Use Option: Direct-Use Heat
+      Surface Application: Absorption Chiller
       Average Direct-Use Heat Production:                     8.49 MW
       Average Cooling Production:                             5.50 MW
       Direct-Use Cooling Breakeven Price (LCOC):              17.52 USD/MMBTU
diff --git a/tests/examples/example12_DH.out b/tests/examples/example12_DH.out
@@ -13,6 +13,7 @@ Simulation Metadata
                            ***SUMMARY OF RESULTS***
 
       End-Use Option: Direct-Use Heat
+      Surface Application: District Heating
       Average Direct-Use Heat Production:                    19.15 MW
       Annual District Heating Demand:                       242.90 GWh/year
       Average Annual Geothermal Heat Production:            144.70 GWh/year
diff --git a/tests/test_geophires_x_client.py b/tests/test_geophires_x_client.py
@@ -85,6 +85,18 @@ def test_direct_use_heat_property(self):
         # Don't care about the value in this test - just that it's being read with the (LCOH)-suffixed name
         self.assertIsNotNone(result.direct_use_heat_breakeven_price_USD_per_MMBTU)
 
+    def test_surface_application_field(self):
+        for example_file, surface_application in [
+            ('examples/example10_HP.out', 'Heat Pump'),
+            ('examples/example11_AC.out', 'Absorption Chiller'),
+            ('examples/example12_DH.out', 'District Heating'),
+        ]:
+            with self.subTest(msg=example_file):
+                test_result_path = self._get_test_file_path(example_file)
+                result = GeophiresXResult(test_result_path)
+
+                assert result.result['SUMMARY OF RESULTS']['Surface Application']['value'] == surface_application
+
     def test_example_multiple_gradients_result(self):
         test_result_path = self._get_test_file_path('examples/example_multiple_gradients.out')
         result = GeophiresXResult(test_result_path)

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '3.4.24'`
	`1`	`+__version__ = '3.4.25'`