Merge pull request #239 from softwareengineerprogrammer/main

Standardize example descriptions/comments

src/geophires_x/GeoPHIRESUtils.py

@@ -520,8 +520,9 @@ def read_input_file(return_dict_1, logger=None, input_file_name=None):
         # successful read of data into list.  Now make a dictionary with all the parameter entries.
         # Index will be the unique name of the parameter.
         # The value will be a "ParameterEntry" structure, with name, value (optionally with units), optional comment
-        for line in content:
-            if line.startswith('#'):
+        for raw_line in content:
+            line = raw_line.strip()
+            if any([line.startswith(x) for x in ['#', '--', '*']]):
                 # skip any line that starts with "#" - # will be the comment parameter
                 continue
 

tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt

@@ -1,10 +1,8 @@
-#GEOPHIRES v3.0 Input File
-#Last modified on 2024-01-29
-#Example Description: Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and Economic Modeling of Heat Production and Electricity Generation"
-#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
-#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
-#This configuration is water filled U-loop with 1 lateral for direct-use heat
-#----------------------------------------------------------------------------------------
+# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
+#   Economic Modeling of Heat Production and Electricity Generation"
+# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
+# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
+# This configuration is water filled U-loop with 1 lateral for direct-use heat.
 
 Is AGS, True
 Closed-loop Configuration, 1
@@ -30,8 +28,8 @@ Circulation Pump Efficiency, 0.8, -----[-]
 #same as default Capital Cost for Surface Plant for Direct-use System, 100.00,    ----$/kWth
 #same as default Dead-state Pressure, 1e5,     ---- bar
 
-*** Economic/Financial Parameters ***
-*************************************
+# *** Economic/Financial Parameters ***
+# *************************************
 Economic Model,4,			--- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
 Fraction of Investment in Bonds,0.65,	--- [-] Required if Bicycle model is selected. See manual for details.
 Inflated Bond Interest Rate,0.07,	--- [-] Required if Bicycle model is selected. See manual for details.
@@ -41,5 +39,5 @@ Combined Income Tax Rate,0.392,		--- [-] Required if Bicycle model is selected.
 Gross Revenue Tax Rate,0,		--- [-] Required if Bicycle model is selected. See manual for details.
 Reservoir Stimulation Capital Cost,0,				--- [M$/injection well] Reservoir stimulation capital cost per injection well
 
-*** Simulation Parameters ***
+# *** Simulation Parameters ***
 Print Output to Console,1,		--- [-] Should be 0 (don't print results to console) or 1 (print results to console)

tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt

@@ -1,10 +1,9 @@
-#GEOPHIRES v3.0 Input File
-#Last modified on 2023-04-12
-#Example Description: Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and Economic Modeling of Heat Production and Electricity Generation"
-#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
-#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
-#This configuration is water filled U-loop with 1 lateral for direct-use heat
-#----------------------------------------------------------------------------------------
+# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
+#    Economic Modeling of Heat Production and Electricity Generation"
+# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
+# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
+# This configuration is water filled U-loop with 1 lateral for direct-use heat
+
 Is AGS, True
 Closed-loop Configuration, 2, ----Coaxial
 End-Use Option, 2,        -----direct heat
@@ -30,8 +29,8 @@ Circulation Pump Efficiency, 0.8, -----[-]
 #same as default Capital Cost for Surface Plant for Direct-use System, 100.00,    ----$/kWth
 #same as default Dead-state Pressure, 1e5,     ---- bar
 
-*** Economic/Financial Parameters ***
-*************************************
+# *** Economic/Financial Parameters ***
+# *************************************
 Economic Model,4,			--- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
 Fraction of Investment in Bonds,0.65,	--- [-] Required if Bicycle model is selected. See manual for details.
 Inflated Bond Interest Rate,0.07,	--- [-] Required if Bicycle model is selected. See manual for details.
@@ -41,5 +40,5 @@ Combined Income Tax Rate,0.392,		--- [-] Required if Bicycle model is selected.
 Gross Revenue Tax Rate,0,		--- [-] Required if Bicycle model is selected. See manual for details.
 Reservoir Stimulation Capital Cost,0,				--- [M$/injection well] Reservoir stimulation capital cost per injection well
 
-*** Simulation Parameters ***
+# *** Simulation Parameters ***
 Print Output to Console,1,		--- [-] Should be 0 (don't print results to console) or 1 (print results to console)

tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt

@@ -1,10 +1,9 @@
-#GEOPHIRES v3.0 Input File
-#Last modified on 2024-01-29
-#Example Description: Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and Economic Modeling of Heat Production and Electricity Generation"
-#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
-#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
-#This configuration is water filled U-loop with 1 lateral for direct-use elec using sCO2
-#----------------------------------------------------------------------------------------
+# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
+#   Economic Modeling of Heat Production and Electricity Generation"
+# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
+# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
+# This configuration is water filled U-loop with 1 lateral for direct-use elec using sCO2
+
 Is AGS, True
 Closed-loop Configuration, 1, ----uloop
 End-Use Option, 1,        -----elec
@@ -25,11 +24,11 @@ Electricity Rate, 0.10,     ----USD/kWh
 Circulation Pump Efficiency, 0.8, -----[-]
 CO2 Turbine Outlet Pressure, 200
 
-*** Economic/Financial Parameters ***
-*************************************
+# *** Economic/Financial Parameters ***
+# *************************************
 Economic Model,4,			--- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
 Reservoir Stimulation Capital Cost,0,				--- [M$/injection well] Reservoir stimulation capital cost per injection well
 Exploration Capital Cost, 0
 
-*** Simulation Parameters ***
+# *** Simulation Parameters ***
 Print Output to Console,1,		--- [-] Should be 0 (don't print results to console) or 1 (print results to console)

tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt

@@ -1,10 +1,9 @@
-#GEOPHIRES v3.0 Input File
-#Last modified on 2023-04-12
-#Example Description: Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and Economic Modeling of Heat Production and Electricity Generation"
-#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
-#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
-#This configuration is water filled U-loop with 1 lateral for direct-use heat using sCO2
-#----------------------------------------------------------------------------------------
+# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
+#   Economic Modeling of Heat Production and Electricity Generation"
+# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
+# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
+# This configuration is water filled U-loop with 1 lateral for direct-use heat using sCO2
+
 Is AGS, True
 Closed-loop Configuration, 1, ----uloop
 End-Use Option, 2,        -----direct heat
@@ -31,8 +30,8 @@ CO2 Turbine Outlet Pressure, 99
 #same as default Capital Cost for Surface Plant for Direct-use System, 100.00,    ----$/kWth
 #same as default Dead-state Pressure, 1e5,     ---- bar
 
-*** Economic/Financial Parameters ***
-*************************************
+# *** Economic/Financial Parameters ***
+# *************************************
 Economic Model,4,			--- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
 Fraction of Investment in Bonds,0.65,	--- [-] Required if Bicycle model is selected. See manual for details.
 Inflated Bond Interest Rate,0.07,	--- [-] Required if Bicycle model is selected. See manual for details.
@@ -42,5 +41,5 @@ Combined Income Tax Rate,0.392,		--- [-] Required if Bicycle model is selected.
 Gross Revenue Tax Rate,0,		--- [-] Required if Bicycle model is selected. See manual for details.
 Reservoir Stimulation Capital Cost,0,				--- [M$/injection well] Reservoir stimulation capital cost per injection well
 
-*** Simulation Parameters ***
+# *** Simulation Parameters ***
 Print Output to Console,1,		--- [-] Should be 0 (don't print results to console) or 1 (print results to console)

tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt

@@ -1,10 +1,9 @@
-#GEOPHIRES v3.0 Input File
-#Last modified on 2024-01-29
-#Example Description: Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and Economic Modeling of Heat Production and Electricity Generation"
-#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
-#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
-#This configuration is water filled U-loop with 1 lateral for direct-use heat using water
-#----------------------------------------------------------------------------------------
+# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
+#   Economic Modeling of Heat Production and Electricity Generation"
+# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
+# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
+# This configuration is water filled U-loop with 1 lateral for direct-use heat using water
+
 Is AGS, True
 Closed-loop Configuration, 1
 End-Use Option, 1,        -----elec
@@ -24,11 +23,11 @@ Ambient Temperature, 20, ----Deg.C "Dead-state temperature"
 Electricity Rate, 0.10,     ----USD/kWh
 Circulation Pump Efficiency, 0.8, -----[-]
 
-*** Economic/Financial Parameters ***
-*************************************
+# *** Economic/Financial Parameters ***
+# *************************************
 Economic Model,4,			--- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
 Reservoir Stimulation Capital Cost,0,				--- [M$/injection well] Reservoir stimulation capital cost per injection well
 Exploration Capital Cost, 0
 
-*** Simulation Parameters ***
+# *** Simulation Parameters ***
 Print Output to Console,1,		--- [-] Should be 0 (don't print results to console) or 1 (print results to console)

tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt

@@ -1,10 +1,9 @@
-#GEOPHIRES v3.0 Input File
-#Last modified on 2023-04-12
-#Example Description: Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and Economic Modeling of Heat Production and Electricity Generation"
-#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
-#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
-#This configuration is water filled U-loop with 1 lateral for direct-use heat usong water
-#----------------------------------------------------------------------------------------
+# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
+#   Economic Modeling of Heat Production and Electricity Generation"
+# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
+# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
+# This configuration is water filled U-loop with 1 lateral for direct-use heat using water
+
 Is AGS, True
 Closed-loop Configuration, 1,    ---uloop
 End-Use Option, 2,        -----direct heat
@@ -30,8 +29,8 @@ Circulation Pump Efficiency, 0.8, -----[-]
 #same as default Capital Cost for Surface Plant for Direct-use System, 100.00,    ----$/kWth
 #same as default Dead-state Pressure, 1e5,     ---- bar
 
-*** Economic/Financial Parameters ***
-*************************************
+# *** Economic/Financial Parameters ***
+# *************************************
 Economic Model,4,			--- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
 Fraction of Investment in Bonds,0.65,	--- [-] Required if Bicycle model is selected. See manual for details.
 Inflated Bond Interest Rate,0.07,	--- [-] Required if Bicycle model is selected. See manual for details.
@@ -41,5 +40,5 @@ Combined Income Tax Rate,0.392,		--- [-] Required if Bicycle model is selected.
 Gross Revenue Tax Rate,0,		--- [-] Required if Bicycle model is selected. See manual for details.
 Reservoir Stimulation Capital Cost,0,				--- [M$/injection well] Reservoir stimulation capital cost per injection well
 
-*** Simulation Parameters ***
+# *** Simulation Parameters ***
 Print Output to Console,1,		--- [-] Should be 0 (don't print results to console) or 1 (print results to console)

tests/examples/Fervo_Norbeck_Latimer_2023.txt

@@ -1,17 +1,17 @@
---- Case Study: Fervo Energy Whitepaper
---- Norbeck J.H. and Latimer T.M. 2023.
----   "Commercial-Scale Demonstration of a First-of-a-Kind Enhanced Geothermal System."
----   https://doi.org/10.31223/X52X0B
----  Drilling Price paper:
----     "Review Of Drilling Performance In A Horizontal EGS Development"
----     Kareem El-Sadi Brittany Gierke Elliot Howard Christian Gradl
----     https://pangea.stanford.edu/ERE/db/GeoConf/papers/SGW/2024/Elsadi.pdf
---- Looking to make:
----         gross power production of 2 to 3.5 MWe
----         production temperature of 336 degF (169 degC)
----         pumping power 500 to 1000 kW
+# Case Study: Fervo Energy Whitepaper
+#  Norbeck J.H. and Latimer T.M. 2023.
+#    "Commercial-Scale Demonstration of a First-of-a-Kind Enhanced Geothermal System."
+#    https://doi.org/10.31223/X52X0B
+#   Drilling Price paper:
+#      "Review Of Drilling Performance In A Horizontal EGS Development"
+#      Kareem El-Sadi Brittany Gierke Elliot Howard Christian Gradl
+#      https://pangea.stanford.edu/ERE/db/GeoConf/papers/SGW/2024/Elsadi.pdf
+#  Looking to make:
+#          gross power production of 2 to 3.5 MWe
+#          production temperature of 336 degF (169 degC)
+#          pumping power 500 to 1000 kW
 
-***Reservoir Parameters***
+# ***Reservoir Parameters***
 Reservoir Model, 1
 Reservoir Volume Option,1,					---Should be 1 2 3 or 4. See manual for details.
 Reservoir Density, 2800, per the paper phyllite + quartzite + diorite + granodiorite,
@@ -27,7 +27,7 @@ Number of Segments,1
 Gradient 1, 76.74, per the paper
 Plant Outlet Pressure, 1500 psi, per the paper
 
-*** Wellbore Parameters***
+# *** Wellbore Parameters***
 Number of Injection Wells, 1,					---[-]
 Number of Production Wells,1,					---[-]
 Well Geometry Configuration, 4,       ----L
@@ -49,7 +49,7 @@ Utilization Factor,.9,						---[-]Water Loss Fraction, .02x
 Water Loss Fraction,0.02,						---[-]
 Maximum Drawdown,1,						---[-] no redrilling considered
 
-***Surfaceplant Parameters***
+# ***Surfaceplant Parameters***
 Ambient Temperature, 8 degC, per the paper. Published ambient is 10.27 degC
 Surface Temperature, 8 degC, per the paper. Published ambient is 10.27 degC
 End-Use Option,1,						---electricity as the main product
@@ -58,7 +58,7 @@ Power Plant Type,2,						---supercritical binary cycle
 End-Use Efficiency Factor,.9,					---[-]
 Circulation Pump Efficiency, 0.80, per the paper
 
-*** Economic Parameters***
+# *** Economic Parameters***
 Economic Model,3,						---BICYCLE Levelized Cost Model
 Starting Electricity Sale Price,0.15
 Ending Electricity Sale Price,1.00, essentially no limit s the rate can rise continuously with inflation
@@ -74,6 +74,6 @@ Investment Tax Credit Rate,0,					---[-] Required for BICYCLE model
 Inflation Rate During Construction, 0.05,				---[-]
 Property Tax Rate,0,						---[-] Required for BICYCLE model
 
-***Other Parameters***
+# ***Other Parameters***
 Print Output to Console, 1,					---Should be 1 (to print) or 0 (to not print)
 Time steps per year,10,						---[-]

tests/examples/S-DAC-GT.txt

@@ -1,11 +1,9 @@
-GEOPHIRES v3.0 Input File
-Geothermal Combined Heat and Power Problem using a Thermal Drawdown Reservoir Model and BICYCLE Economic Model and Solid Sorbent Direct Air Capture powered by geothermal
-
-Based on Example 3 description: This example problem considers an EGS reservoir at 3.1km depth.
-The heat is used in a combined heat and power topping cycle model with double flash as
-topping cycle and electricity considered as the main product.
-
-But only lists those parameters that are different than their default values
+# Geothermal Combined Heat and Power Problem using a Thermal Drawdown Reservoir Model and BICYCLE Economic Model and
+# Solid Sorbent Direct Air Capture powered by geothermal
+# Based on Example 3 description: This example problem considers an EGS reservoir at 3.1km depth.
+# The heat is used in a combined heat and power topping cycle model with double flash as
+# topping cycle and electricity considered as the main product.
+# But only lists those parameters that are different than their default values
 
 Do S-DAC-GT Calculations, True