GEOPHIRES is a free and open-source geothermal techno-economic simulator. GEOPHIRES combines reservoir, wellbore, surface plant, and economic models to estimate the capital and operation and maintenance costs, instantaneous and lifetime energy production, and overall levelized cost of energy of a geothermal plant. Various reservoir conditions (EGS, doublets, etc.) and end-use options (electricity, direct-use heat, cogeneration) can be modeled. Users are encouraged to build upon to the GEOPHIRES framework to implement their own correlations and models.
GEOPHIRES-X is the successor version to GEOPHIRES v2.0 (see CHANGELOG for more info).
Free software: MIT license
| tests | 
 |
|---|---|
| package | 
|
A web interface is available at gtp.scientificwebservices.com/geophires.
The short URL bit.ly/geophires redirects to the same location.
If you do not need to view or edit GEOPHIRES-X source code, you can consume GEOPHIRES-X as a regular, non-editable python package:
pip3 install https://github.com/NREL/GEOPHIRES-X/archive/main.zip
An editable installation is recommended for most users. It will allow you to run GEOPHIRES-X locally, view its Python files in an IDE or text editor, and create your own extensions as described in How to extend GEOPHIRES-X.
Prerequisites:
- Python 3.8+: You must have Python 3.8 or later installed on your machine. Python can be downloaded at python.org/downloads. (On Ubuntu:
alias python=python3if not aliased already.) - Git
- Virtual environment (aka
virtualenv): Install virtual environment on your machine if you don't have it already - On Windows, you will need Admin privileges (required to successfully activate the virtual environment)
Steps:
Open a command line (i.e. Terminal on Mac, PowerShell on Windows)
Create a directory for GEOPHIRES:
mkdir my-geophires-project cd my-geophires-project
Create a virtual environment:
python -m venv venv
Source the virtual environment:
Windows:
venv\Scripts\activate
macOS/Linux:
source venv/bin/activate
Install the
geophires-xpackage:pip3 install -e git+https://github.com/NREL/GEOPHIRES-X.git#egg=geophires-x --src .
Run on an example file:
cd geophires-x cd tests cd examples python -mgeophires_x example1.txt
View and edit source code by opening the
my-geophires-project/directory in an IDE or editor such as PyCharm, Spyder, or Visual Studio Code. The GEOPHIRES-X source code will be located in themy-geophires-project/geophires-xdirectory. You can add your own python files inmy-geophires-x/that use the source as a module as shown below.
To update the editable installation with the latest GEOPHIRES version:
cd geophires-x git pull # resolve merge conflicts, if any pip install -e .
Example usage in Python:
from geophires_x_client import GeophiresXClient
from geophires_x_client.geophires_input_parameters import GeophiresInputParameters
client = GeophiresXClient()
result = client.get_geophires_result(
GeophiresInputParameters({
"Gradient 1": "69",
"Reservoir Depth": "5",
"End-Use Option": "1",
"Power Plant Type": "4"
})
)
with open(result.output_file_path, 'r') as f:
print(f.read())If you followed the editable installation example above, put this code in my-geophires-project/main.py, then run:
python main.py
You will then see output including a case report:
(venv) ➜ my-geophires-project python main.py
No valid plant outlet pressure provided. GEOPHIRES will assume default plant outlet pressure (100 kPa)
No valid plant outlet pressure provided. GEOPHIRES will assume default plant outlet pressure (100 kPa)
*****************
***CASE REPORT***
*****************
Simulation Metadata
----------------------
GEOPHIRES Version: 3.4.42
Simulation Date: 2024-07-08
Simulation Time: 10:07
Calculation Time: 0.047 sec
***SUMMARY OF RESULTS***
End-Use Option: Electricity
Average Net Electricity Production: 23.94 MW
Electricity breakeven price: 5.04 cents/kWh
[...]
You may also pass parameters as a text file:
from pathlib import Path
from geophires_x_client import GeophiresXClient
from geophires_x_client.geophires_input_parameters import GeophiresInputParameters
# https://github.com/NREL/GEOPHIRES-X/blob/main/tests/examples/example1.txt
example_file_path = Path('geophires-x/tests/examples/example1.txt').absolute()
client = GeophiresXClient()
result = client.get_geophires_result(
GeophiresInputParameters(from_file_path=example_file_path)
)
with open(result.output_file_path, 'r') as f:
print(f.read())test_geophires_x.py has additional examples of how to consume and call GeophiresXClient.
If you installed with pip (editable or non-), you may run GEOPHIRES from the command line, passing your input file as an argument:
python -mgeophires_x my_geophires_input.txt
You may also optionally pass the output file as well:
python -mgeophires_x my_geophires_input.txt my_geophires_result.out
(If you do not pass an output file argument a default name will be used.)
A variety of example input .txt files and corresponding case report .out files are available in the tests/examples directory of the repository:
An interactive table of examples is available at gtp.scientificwebservices.com/geophires, under the Examples tab.
Available parameters are documented in the Parameters Reference.
The GEOPHIRES v2.0 (previous version's) user manual describes GEOPHIRES's high-level software architecture.
Theoretical basis for GEOPHIRES: GEOPHIRES v2.0: updated geothermal techno‐economic simulation tool
Additional materials in /References
If you are interested in sharing your extensions with others, or even contributing them back to this repository, you may want to follow the Development instructions. (You can also create a fork after doing an editable install so don't worry about picking this method if you're unsure.)