Merge pull request #43 from softwareengineerprogrammer/well-depth-fixes

"Well depth" instead of "Well depth (or total length, if not vertical)"

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.6.9
+current_version = 3.7.0
 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.6.9
+    version: 3.7.0
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

CHANGELOG.rst

@@ -5,6 +5,14 @@ Changelog
 GEOPHIRES-X (2023-2024)
 ------------------------
 
+3.7
+^^^
+
+`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.7.0>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.6.0...v3.7.0>`__
+
+"Well depth (or total length, if not vertical)" output field renamed to "Well depth" per https://github.com/NREL/GEOPHIRES-X/issues/321
+
+
 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.6.9.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.7.0.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.6.9...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.7.0...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.6.9'
+version = release = '3.7.0'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

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

src/geophires_x/Outputs.py

@@ -638,6 +638,8 @@ class Outputs:
     This class handles all the outputs for the GEOPHIRESv3 model.
     """
 
+    VERTICAL_WELL_DEPTH_OUTPUT_NAME = 'Well depth'
+
     def __init__(self, model:Model, output_file:str ='HDR.out'):
         model.logger.info(f'Init {__class__!s}: {__name__}')
         self.ParameterDict = {}
@@ -860,7 +862,7 @@ def PrintOutputs(self, model: Model):
         summary.append(OutputTableItem('Number of injection wells', '{0:10.0f}'.format(model.wellbores.ninj.value)))
         summary.append(OutputTableItem('Flowrate per production well', '{0:10.1f}'.format(model.wellbores.prodwellflowrate.value),
                             model.wellbores.prodwellflowrate.CurrentUnits.value))
-        summary.append(OutputTableItem('Well depth (or total length, if not vertical)',
+        summary.append(OutputTableItem(Outputs.VERTICAL_WELL_DEPTH_OUTPUT_NAME,
                                        '{0:10.1f}'.format(model.reserv.depth.value),
                                        model.reserv.depth.CurrentUnits.value))
 
@@ -926,7 +928,7 @@ def PrintOutputs(self, model: Model):
 
         engineering_parameters.append(OutputTableItem('Number of Production Wells', '{0:10.0f}'.format(model.wellbores.nprod.value)))
         engineering_parameters.append(OutputTableItem('Number of Injection Wells', '{0:10.0f}'.format(model.wellbores.ninj.value)))
-        engineering_parameters.append(OutputTableItem('Well depth (or total length, if not vertical)',
+        engineering_parameters.append(OutputTableItem(Outputs.VERTICAL_WELL_DEPTH_OUTPUT_NAME,
                                                       '{0:10.1f}'.format(model.reserv.depth.value),
                                                       model.reserv.depth.CurrentUnits.value))
         engineering_parameters.append(OutputTableItem('Water loss rate', '{0:10.1f}'.format(model.reserv.waterloss.value * 100),
@@ -1613,7 +1615,7 @@ def PrintOutputs(self, model: Model):
                 f.write(f'      Number of production wells:                    {model.wellbores.nprod.value:10.0f}'+NL)
                 f.write(f'      Number of injection wells:                     {model.wellbores.ninj.value:10.0f}'+NL)
                 f.write(f'      Flowrate per production well:                    {model.wellbores.prodwellflowrate.value:10.1f} '  + model.wellbores.prodwellflowrate.CurrentUnits.value + NL)
-                f.write(f'      Well depth (or total length, if not vertical):   {model.reserv.depth.value:10.1f} ' +model.reserv.depth.CurrentUnits.value + NL)
+                f.write(f'      {Outputs._field_label(Outputs.VERTICAL_WELL_DEPTH_OUTPUT_NAME, 49)}{model.reserv.depth.value:10.1f} ' + model.reserv.depth.CurrentUnits.value + NL)
 
                 if model.reserv.numseg.value == 1:
                     f.write(f'      Geothermal gradient:                             {model.reserv.gradient.value[0]:10.4g} ' + model.reserv.gradient.CurrentUnits.value + NL)
@@ -1669,7 +1671,7 @@ def PrintOutputs(self, model: Model):
                 f.write(NL)
                 f.write(f'      Number of Production Wells:                    {model.wellbores.nprod.value:10.0f}' + NL)
                 f.write(f'      Number of Injection Wells:                     {model.wellbores.ninj.value:10.0f}' + NL)
-                f.write(f'      Well depth (or total length, if not vertical):   {model.reserv.depth.value:10.1f} ' + model.reserv.depth.CurrentUnits.value + NL)
+                f.write(f'      {Outputs._field_label(Outputs.VERTICAL_WELL_DEPTH_OUTPUT_NAME, 49)}{model.reserv.depth.value:10.1f} ' + model.reserv.depth.CurrentUnits.value + NL)
                 f.write(f'      Water loss rate:                                 {model.reserv.waterloss.value*100:10.1f} ' + model.reserv.waterloss.CurrentUnits.value + NL)
                 f.write(f'      Pump efficiency:                                 {model.surfaceplant.pump_efficiency.value:10.1f} ' + model.surfaceplant.pump_efficiency.CurrentUnits.value + NL)
                 f.write(f'      Injection temperature:                           {model.wellbores.Tinj.value:10.1f} ' + model.wellbores.Tinj.CurrentUnits.value + NL)
@@ -2163,3 +2165,7 @@ def o(output_param: OutputParameter):
 
 
         model.logger.info(f'Complete {__class__!s}: {sys._getframe().f_code.co_name}')
+
+    @staticmethod
+    def _field_label(field_name:str, print_width_before_value: int) -> str:
+        return f'{field_name}:{" " * (print_width_before_value - len(field_name) - 1)}'

src/geophires_x/SUTRAOutputs.py

@@ -97,7 +97,7 @@ def PrintOutputs(self, model: Model):
                 f.write(NL)
                 f.write(f"      Number of Production Wells:                    {model.wellbores.nprod.value:10.0f}" + NL)
                 f.write(f"      Number of Injection Wells:                     {model.wellbores.ninj.value:10.0f}" + NL)
-                f.write(f"      Well Depth:                                    {model.reserv.depth.value:10.1f} " + model.reserv.depth.CurrentUnits.value + NL)
+                f.write(f"      Well depth:                                    {model.reserv.depth.value:10.1f} " + model.reserv.depth.CurrentUnits.value + NL)
 
                 pump_efficiency_display_unit = model.surfaceplant.pump_efficiency.CurrentUnits.value
                 pump_efficiency_display = f'{model.surfaceplant.pump_efficiency.value:10.1f} {pump_efficiency_display_unit}'

src/geophires_x/SurfacePlantDoubleFlash.py

@@ -118,7 +118,7 @@ def Calculate(self, model: Model) -> None:
                                                 model.wellbores.Tinj.value, ReinjTemp, self.T_chp_bottom.value,
                                                  self.enduse_efficiency_factor.value, self.chp_fraction.value)
 
-        # subtract pumping power for net electricity and  calculate first law efficiency
+        # subtract pumping power for net electricity and calculate first law efficiency
         self.NetElectricityProduced.value = self.ElectricityProduced.value - model.wellbores.PumpingPower.value
         self.FirstLawEfficiency.value = self.NetElectricityProduced.value/HeatExtractedTowardsElectricity
 

src/geophires_x/__init__.py

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