Skip to content

Commit 3f2adb4

Browse files
Simplify example input parameters and show example output
1 parent 43c85f9 commit 3f2adb4

File tree

1 file changed

+31
-47
lines changed

1 file changed

+31
-47
lines changed

README.rst

Lines changed: 31 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Editable Installation (Recommended)
9090
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9191

9292
An editable installation is recommended for most users. It will allow you to run GEOPHIRES-X locally,
93-
view its python files in an IDE or text editor,
93+
view its Python files in an IDE or text editor,
9494
and create your own extensions as described in `How to extend GEOPHIRES-X <docs/How-to-extend-GEOPHIRES-X.md#how-to-extend-geophires-x>`__.
9595

9696
Prerequisites:
@@ -169,52 +169,10 @@ Example usage in Python:
169169
client = GeophiresXClient()
170170
result = client.get_geophires_result(
171171
GeophiresInputParameters({
172-
"Reservoir Model": 1,
173-
"Reservoir Depth": 3,
174-
"Number of Segments": 1,
175-
"Gradient 1": 50,
176-
"Number of Production Wells": 2,
177-
"Number of Injection Wells": 2,
178-
"Production Well Diameter": 7,
179-
"Injection Well Diameter": 7,
180-
"Ramey Production Wellbore Model": 1,
181-
"Production Wellbore Temperature Drop": .5,
182-
"Injection Wellbore Temperature Gain": 0,
183-
"Production Flow Rate per Well": 55,
184-
"Fracture Shape": 3,
185-
"Fracture Height": 900,
186-
"Reservoir Volume Option": 3,
187-
"Number of Fractures": 20,
188-
"Reservoir Volume": 1000000000,
189-
"Water Loss Fraction": .02,
190-
"Productivity Index": 5,
191-
"Injectivity Index": 5,
192-
"Injection Temperature": 50,
193-
"Maximum Drawdown": 1,
194-
"Reservoir Heat Capacity": 1000,
195-
"Reservoir Density": 2700,
196-
"Reservoir Thermal Conductivity": 2.7,
197-
"End-Use Option": 1,
198-
"Power Plant Type": 2,
199-
"Circulation Pump Efficiency": .8,
200-
"Utilization Factor": .9,
201-
"Surface Temperature": 20,
202-
"Ambient Temperature": 20,
203-
"Plant Lifetime": 30,
204-
"Economic Model": 1,
205-
"Fixed Charge Rate": .05,
206-
"Inflation Rate During Construction": 0,
207-
"Well Drilling and Completion Capital Cost Adjustment Factor": 1,
208-
"Well Drilling Cost Correlation": 1,
209-
"Reservoir Stimulation Capital Cost Adjustment Factor": 1,
210-
"Surface Plant Capital Cost Adjustment Factor": 1,
211-
"Field Gathering System Capital Cost Adjustment Factor": 1,
212-
"Exploration Capital Cost Adjustment Factor": 1,
213-
"Wellfield O&M Cost Adjustment Factor": 1,
214-
"Surface Plant O&M Cost Adjustment Factor": 1,
215-
"Water Cost Adjustment Factor": 1,
216-
"Print Output to Console": 1,
217-
"Time steps per year": 6
172+
"Gradient 1": "69",
173+
"Reservoir Depth": "5",
174+
"End-Use Option": "1",
175+
"Power Plant Type": "4"
218176
})
219177
)
220178
@@ -225,6 +183,32 @@ If you followed the editable installation example above, put this code in ``my-g
225183

226184
python main.py
227185

186+
You will then see output including a case report::
187+
188+
(venv) ➜ my-geophires-project python main.py
189+
No valid plant outlet pressure provided. GEOPHIRES will assume default plant outlet pressure (100 kPa)
190+
No valid plant outlet pressure provided. GEOPHIRES will assume default plant outlet pressure (100 kPa)
191+
192+
*****************
193+
***CASE REPORT***
194+
*****************
195+
196+
Simulation Metadata
197+
----------------------
198+
GEOPHIRES Version: 3.4.42
199+
Simulation Date: 2024-07-08
200+
Simulation Time: 10:07
201+
Calculation Time: 0.047 sec
202+
203+
***SUMMARY OF RESULTS***
204+
205+
End-Use Option: Electricity
206+
Average Net Electricity Production: 23.94 MW
207+
Electricity breakeven price: 5.04 cents/kWh
208+
209+
[...]
210+
211+
228212
You may also pass parameters as a text file:
229213

230214
.. code:: python

0 commit comments

Comments
 (0)