Merge pull request NREL#416 from softwareengineerprogrammer/main

HIP-RA-X Print Output to Console parameter [v3.9.50]

Author: softwareengineerprogrammer

.bumpversion.cfg

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

CHANGELOG.rst

@@ -7,6 +7,7 @@ GEOPHIRES v3 (2023-2025)
 
 3.9
 ^^^
+3.9.50: `HIP-RA-X Print Output to Console parameter <https://github.com/NREL/GEOPHIRES-X/pull/416>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.50>`__
 
 3.9.49: `Fervo_Project_Cape-4 Stimulation Costs Update <https://github.com/NREL/GEOPHIRES-X/pull/414>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.49>`__
 

README.rst

@@ -58,9 +58,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.9.49.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.50.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.49...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.50...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -288,7 +288,7 @@ Example-specific web interface deeplinks are listed in the Link column.
      - `Fervo_Project_Cape-3.txt <tests/examples/Fervo_Project_Cape-3.txt>`__
      - `.out <tests/examples/Fervo_Project_Cape-3.out>`__
      - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Project_Cape-3>`__
-   * - Case Study: 500 MWe EGS Project Modeled on Fervo Cape Station (`documentation <https://softwareengineerprogrammer.github.io/GEOPHIRES/Fervo_Project_Cape-4.html>`__)
+   * - Case Study: 500 MWe EGS Project Modeled on Fervo Cape Station (`documentation <https://nrel.github.io/GEOPHIRES-X/Fervo_Project_Cape-4.html>`__)
      - `Fervo_Project_Cape-4.txt <tests/examples/Fervo_Project_Cape-4.txt>`__
      - `.out <tests/examples/Fervo_Project_Cape-4.out>`__
      - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Project_Cape-4>`__

docs/Fervo_Project_Cape-4.md

@@ -112,7 +112,7 @@ sensitivity analysis using [GEOPHIRES's Monte Carlo simulation module](Monte-Car
 
 The following tables and heatmaps show Electricity breakeven price (LCOE) and NPV sensitivity to stimulation cost and inflation costs during construction (a proxy for construction delays and cost overruns).
 Stimulation costs were tested from $2.3M/well (Reservoir Stimulation Capital Cost Adjustment Factor = 0.5) to $9.2M/well (Reservoir Stimulation Capital Cost Adjustment Factor = 2).
-Construction inflation costs were tested from $53.58M (Inflation Rate During Construction = 2.3%) to $340.13M (Inflation Rate During Construction = 14.6%).
+Inflation Rate During Construction was tested from 2.3% to 14.6%, yielding construction inflation costs ranging from $53.6M to $459M.
 
 #### LCOE
 

docs/conf.py

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

setup.py

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

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.9.49'
+__version__ = '3.9.50'

src/geophires_x_schema_generator/hip-ra-x-request.json

@@ -168,6 +168,15 @@
       "default": "HIP.html",
       "minimum": null,
       "maximum": null
+    },
+    "Print Output to Console": {
+      "description": "Provide False if you do not want to print output to the console",
+      "type": "boolean",
+      "units": null,
+      "category": null,
+      "default": true,
+      "minimum": null,
+      "maximum": null
     }
   }
 }

src/hip_ra_x/hip_ra_x.py

@@ -27,6 +27,7 @@
 from geophires_x.Parameter import Parameter
 from geophires_x.Parameter import ParameterEntry
 from geophires_x.Parameter import ReadParameter
+from geophires_x.Parameter import boolParameter
 from geophires_x.Parameter import floatParameter
 from geophires_x.Parameter import intParameter
 from geophires_x.Parameter import strParameter
@@ -353,6 +354,15 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
             )
         )
 
+        self.print_output_to_console = parameter_dict_entry(
+            boolParameter(
+                'Print Output to Console',
+                DefaultValue=True,
+                UnitType=Units.NONE,
+                ToolTipText='Provide False if you do not want to print output to the console',
+            )
+        )
+
         # Output parameters
         self.reservoir_volume = self.OutputParameterDict[self.reservoir_volume.Name] = OutputParameter(
             Name='Reservoir Volume (reservoir)',
@@ -925,7 +935,7 @@ def render_scientific(p: Parameter) -> str:
         if self.html_output_file.Provided:
             # write the outputs to the output file as HTML and the screen as a table
             self.PrintOutputsHTML(case_data_inputs, case_data_results, self.html_output_file.value)
-        else:
+        elif self.print_output_to_console.value:
             # copy the output file to the screen
             with open(outputfile, encoding='UTF-8') as f:
                 content = f.readlines()  # store all output in one long list