Skip to content

Commit fc5ae79

Browse files
softwareengineerprogrammersoftwareengineerprogrammer
authored
Merge pull request NREL#239 from softwareengineerprogrammer/main
Standardize example descriptions/comments
2 parents 90ff58b + 40d84d5 commit fc5ae79

34 files changed

+354
-382
lines changed

‎src/geophires_x/GeoPHIRESUtils.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -520,8 +520,9 @@ def read_input_file(return_dict_1, logger=None, input_file_name=None):
520520
# successful read of data into list. Now make a dictionary with all the parameter entries.
521521
# Index will be the unique name of the parameter.
522522
# The value will be a "ParameterEntry" structure, with name, value (optionally with units), optional comment
523-
for line in content:
524-
if line.startswith('#'):
523+
for raw_line in content:
524+
line = raw_line.strip()
525+
if any([line.startswith(x) for x in ['#', '--', '*']]):
525526
# skip any line that starts with "#" - # will be the comment parameter
526527
continue
527528

‎tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
#GEOPHIRES v3.0 Input File
2-
#Last modified on 2024-01-29
3-
#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"
4-
#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
5-
#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
6-
#This configuration is water filled U-loop with 1 lateral for direct-use heat
7-
#----------------------------------------------------------------------------------------
1+
# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
2+
# Economic Modeling of Heat Production and Electricity Generation"
3+
# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
4+
# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
5+
# This configuration is water filled U-loop with 1 lateral for direct-use heat.
86

97
Is AGS, True
108
Closed-loop Configuration, 1
@@ -30,8 +28,8 @@ Circulation Pump Efficiency, 0.8, -----[-]
3028
#same as default Capital Cost for Surface Plant for Direct-use System, 100.00, ----$/kWth
3129
#same as default Dead-state Pressure, 1e5, ---- bar
3230

33-
*** Economic/Financial Parameters ***
34-
*************************************
31+
# *** Economic/Financial Parameters ***
32+
# *************************************
3533
Economic Model,4, --- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
3634
Fraction of Investment in Bonds,0.65, --- [-] Required if Bicycle model is selected. See manual for details.
3735
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.
4139
Gross Revenue Tax Rate,0, --- [-] Required if Bicycle model is selected. See manual for details.
4240
Reservoir Stimulation Capital Cost,0, --- [M$/injection well] Reservoir stimulation capital cost per injection well
4341

44-
*** Simulation Parameters ***
42+
# *** Simulation Parameters ***
4543
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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
#GEOPHIRES v3.0 Input File
2-
#Last modified on 2023-04-12
3-
#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"
4-
#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
5-
#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
6-
#This configuration is water filled U-loop with 1 lateral for direct-use heat
7-
#----------------------------------------------------------------------------------------
1+
# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
2+
# Economic Modeling of Heat Production and Electricity Generation"
3+
# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
4+
# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
5+
# This configuration is water filled U-loop with 1 lateral for direct-use heat
6+
87
Is AGS, True
98
Closed-loop Configuration, 2, ----Coaxial
109
End-Use Option, 2, -----direct heat
@@ -30,8 +29,8 @@ Circulation Pump Efficiency, 0.8, -----[-]
3029
#same as default Capital Cost for Surface Plant for Direct-use System, 100.00, ----$/kWth
3130
#same as default Dead-state Pressure, 1e5, ---- bar
3231

33-
*** Economic/Financial Parameters ***
34-
*************************************
32+
# *** Economic/Financial Parameters ***
33+
# *************************************
3534
Economic Model,4, --- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
3635
Fraction of Investment in Bonds,0.65, --- [-] Required if Bicycle model is selected. See manual for details.
3736
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.
4140
Gross Revenue Tax Rate,0, --- [-] Required if Bicycle model is selected. See manual for details.
4241
Reservoir Stimulation Capital Cost,0, --- [M$/injection well] Reservoir stimulation capital cost per injection well
4342

44-
*** Simulation Parameters ***
43+
# *** Simulation Parameters ***
4544
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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
#GEOPHIRES v3.0 Input File
2-
#Last modified on 2024-01-29
3-
#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"
4-
#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
5-
#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
6-
#This configuration is water filled U-loop with 1 lateral for direct-use elec using sCO2
7-
#----------------------------------------------------------------------------------------
1+
# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
2+
# Economic Modeling of Heat Production and Electricity Generation"
3+
# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
4+
# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
5+
# This configuration is water filled U-loop with 1 lateral for direct-use elec using sCO2
6+
87
Is AGS, True
98
Closed-loop Configuration, 1, ----uloop
109
End-Use Option, 1, -----elec
@@ -25,11 +24,11 @@ Electricity Rate, 0.10, ----USD/kWh
2524
Circulation Pump Efficiency, 0.8, -----[-]
2625
CO2 Turbine Outlet Pressure, 200
2726

28-
*** Economic/Financial Parameters ***
29-
*************************************
27+
# *** Economic/Financial Parameters ***
28+
# *************************************
3029
Economic Model,4, --- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
3130
Reservoir Stimulation Capital Cost,0, --- [M$/injection well] Reservoir stimulation capital cost per injection well
3231
Exploration Capital Cost, 0
3332

34-
*** Simulation Parameters ***
33+
# *** Simulation Parameters ***
3534
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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
#GEOPHIRES v3.0 Input File
2-
#Last modified on 2023-04-12
3-
#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"
4-
#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
5-
#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
6-
#This configuration is water filled U-loop with 1 lateral for direct-use heat using sCO2
7-
#----------------------------------------------------------------------------------------
1+
# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
2+
# Economic Modeling of Heat Production and Electricity Generation"
3+
# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
4+
# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
5+
# This configuration is water filled U-loop with 1 lateral for direct-use heat using sCO2
6+
87
Is AGS, True
98
Closed-loop Configuration, 1, ----uloop
109
End-Use Option, 2, -----direct heat
@@ -31,8 +30,8 @@ CO2 Turbine Outlet Pressure, 99
3130
#same as default Capital Cost for Surface Plant for Direct-use System, 100.00, ----$/kWth
3231
#same as default Dead-state Pressure, 1e5, ---- bar
3332

34-
*** Economic/Financial Parameters ***
35-
*************************************
33+
# *** Economic/Financial Parameters ***
34+
# *************************************
3635
Economic Model,4, --- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
3736
Fraction of Investment in Bonds,0.65, --- [-] Required if Bicycle model is selected. See manual for details.
3837
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.
4241
Gross Revenue Tax Rate,0, --- [-] Required if Bicycle model is selected. See manual for details.
4342
Reservoir Stimulation Capital Cost,0, --- [M$/injection well] Reservoir stimulation capital cost per injection well
4443

45-
*** Simulation Parameters ***
44+
# *** Simulation Parameters ***
4645
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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
#GEOPHIRES v3.0 Input File
2-
#Last modified on 2024-01-29
3-
#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"
4-
#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
5-
#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
6-
#This configuration is water filled U-loop with 1 lateral for direct-use heat using water
7-
#----------------------------------------------------------------------------------------
1+
# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
2+
# Economic Modeling of Heat Production and Electricity Generation"
3+
# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
4+
# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
5+
# This configuration is water filled U-loop with 1 lateral for direct-use heat using water
6+
87
Is AGS, True
98
Closed-loop Configuration, 1
109
End-Use Option, 1, -----elec
@@ -24,11 +23,11 @@ Ambient Temperature, 20, ----Deg.C "Dead-state temperature"
2423
Electricity Rate, 0.10, ----USD/kWh
2524
Circulation Pump Efficiency, 0.8, -----[-]
2625

27-
*** Economic/Financial Parameters ***
28-
*************************************
26+
# *** Economic/Financial Parameters ***
27+
# *************************************
2928
Economic Model,4, --- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
3029
Reservoir Stimulation Capital Cost,0, --- [M$/injection well] Reservoir stimulation capital cost per injection well
3130
Exploration Capital Cost, 0
3231

33-
*** Simulation Parameters ***
32+
# *** Simulation Parameters ***
3433
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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
#GEOPHIRES v3.0 Input File
2-
#Last modified on 2023-04-12
3-
#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"
4-
#Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
5-
#Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
6-
#This configuration is water filled U-loop with 1 lateral for direct-use heat usong water
7-
#----------------------------------------------------------------------------------------
1+
# Example 1 from "Tabulated Database of Closed-Loop Geothermal Systems Performance for Cloud-Based Technical and
2+
# Economic Modeling of Heat Production and Electricity Generation"
3+
# Koenraad Beckers Yaroslav Vasyliv Gabriela A. Bran-Anleu Mario Martinez Chad Augustine and Mark White
4+
# Presented at the 48th Stanford Geothermal Workshop Stanford California February 6-8 2023
5+
# This configuration is water filled U-loop with 1 lateral for direct-use heat using water
6+
87
Is AGS, True
98
Closed-loop Configuration, 1, ---uloop
109
End-Use Option, 2, -----direct heat
@@ -30,8 +29,8 @@ Circulation Pump Efficiency, 0.8, -----[-]
3029
#same as default Capital Cost for Surface Plant for Direct-use System, 100.00, ----$/kWth
3130
#same as default Dead-state Pressure, 1e5, ---- bar
3231

33-
*** Economic/Financial Parameters ***
34-
*************************************
32+
# *** Economic/Financial Parameters ***
33+
# *************************************
3534
Economic Model,4, --- Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) 3 (Bicycle model) 4 CLGS.
3635
Fraction of Investment in Bonds,0.65, --- [-] Required if Bicycle model is selected. See manual for details.
3736
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.
4140
Gross Revenue Tax Rate,0, --- [-] Required if Bicycle model is selected. See manual for details.
4241
Reservoir Stimulation Capital Cost,0, --- [M$/injection well] Reservoir stimulation capital cost per injection well
4342

44-
*** Simulation Parameters ***
43+
# *** Simulation Parameters ***
4544
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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
--- Case Study: Fervo Energy Whitepaper
2-
--- Norbeck J.H. and Latimer T.M. 2023.
3-
--- "Commercial-Scale Demonstration of a First-of-a-Kind Enhanced Geothermal System."
4-
--- https://doi.org/10.31223/X52X0B
5-
--- Drilling Price paper:
6-
--- "Review Of Drilling Performance In A Horizontal EGS Development"
7-
--- Kareem El-Sadi Brittany Gierke Elliot Howard Christian Gradl
8-
--- https://pangea.stanford.edu/ERE/db/GeoConf/papers/SGW/2024/Elsadi.pdf
9-
--- Looking to make:
10-
--- gross power production of 2 to 3.5 MWe
11-
--- production temperature of 336 degF (169 degC)
12-
--- pumping power 500 to 1000 kW
1+
# Case Study: Fervo Energy Whitepaper
2+
# Norbeck J.H. and Latimer T.M. 2023.
3+
# "Commercial-Scale Demonstration of a First-of-a-Kind Enhanced Geothermal System."
4+
# https://doi.org/10.31223/X52X0B
5+
# Drilling Price paper:
6+
# "Review Of Drilling Performance In A Horizontal EGS Development"
7+
# Kareem El-Sadi Brittany Gierke Elliot Howard Christian Gradl
8+
# https://pangea.stanford.edu/ERE/db/GeoConf/papers/SGW/2024/Elsadi.pdf
9+
# Looking to make:
10+
# gross power production of 2 to 3.5 MWe
11+
# production temperature of 336 degF (169 degC)
12+
# pumping power 500 to 1000 kW
1313

14-
***Reservoir Parameters***
14+
# ***Reservoir Parameters***
1515
Reservoir Model, 1
1616
Reservoir Volume Option,1, ---Should be 1 2 3 or 4. See manual for details.
1717
Reservoir Density, 2800, per the paper phyllite + quartzite + diorite + granodiorite,
@@ -27,7 +27,7 @@ Number of Segments,1
2727
Gradient 1, 76.74, per the paper
2828
Plant Outlet Pressure, 1500 psi, per the paper
2929

30-
*** Wellbore Parameters***
30+
# *** Wellbore Parameters***
3131
Number of Injection Wells, 1, ---[-]
3232
Number of Production Wells,1, ---[-]
3333
Well Geometry Configuration, 4, ----L
@@ -49,7 +49,7 @@ Utilization Factor,.9, ---[-]Water Loss Fraction, .02x
4949
Water Loss Fraction,0.02, ---[-]
5050
Maximum Drawdown,1, ---[-] no redrilling considered
5151

52-
***Surfaceplant Parameters***
52+
# ***Surfaceplant Parameters***
5353
Ambient Temperature, 8 degC, per the paper. Published ambient is 10.27 degC
5454
Surface Temperature, 8 degC, per the paper. Published ambient is 10.27 degC
5555
End-Use Option,1, ---electricity as the main product
@@ -58,7 +58,7 @@ Power Plant Type,2, ---supercritical binary cycle
5858
End-Use Efficiency Factor,.9, ---[-]
5959
Circulation Pump Efficiency, 0.80, per the paper
6060

61-
*** Economic Parameters***
61+
# *** Economic Parameters***
6262
Economic Model,3, ---BICYCLE Levelized Cost Model
6363
Starting Electricity Sale Price,0.15
6464
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
7474
Inflation Rate During Construction, 0.05, ---[-]
7575
Property Tax Rate,0, ---[-] Required for BICYCLE model
7676

77-
***Other Parameters***
77+
# ***Other Parameters***
7878
Print Output to Console, 1, ---Should be 1 (to print) or 0 (to not print)
7979
Time steps per year,10, ---[-]

‎tests/examples/S-DAC-GT.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
GEOPHIRES v3.0 Input File
2-
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
3-
4-
Based on Example 3 description: This example problem considers an EGS reservoir at 3.1km depth.
5-
The heat is used in a combined heat and power topping cycle model with double flash as
6-
topping cycle and electricity considered as the main product.
7-
8-
But only lists those parameters that are different than their default values
1+
# Geothermal Combined Heat and Power Problem using a Thermal Drawdown Reservoir Model and BICYCLE Economic Model and
2+
# Solid Sorbent Direct Air Capture powered by geothermal
3+
# Based on Example 3 description: This example problem considers an EGS reservoir at 3.1km depth.
4+
# The heat is used in a combined heat and power topping cycle model with double flash as
5+
# topping cycle and electricity considered as the main product.
6+
# But only lists those parameters that are different than their default values
97

108
Do S-DAC-GT Calculations, True
119

0 commit comments

Comments
 (0)