GEOPHIRES v2.0

⚠️ Deprecated

This version of GEOPHIRES is deprecated. Use GEOPHIRES-X instead.

GEOPHIRES v2.0 Description

GEOPHIRES v2.0 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. The tool can be coupled to the external reservoir simulation TOUGH2. Users are encouraged to build upon to the GEOPHIRES v2.0 framework to implement their own correlations and models.

GitHub Folder Info

This GitHub folder contains the following folders and files:

GEOPHIRESv2.py: GEOPHIRES v2 Python code
GEOPHIRES v2.0 User Manual.pdf: User manual including quick start guide and list of all input parameters.
References/: Folder containing reference documents on GEOPHIRES
Examples/: Folder containing example problems

Importing as Python Module

GEOPHIRES-v2 can be imported as a Python module, allowing it to be consumed programmatically.

Add it as a git submodule by running the following in your project's root folder (i.e. my-geophires-project/):

git submodule add git@github.com:NREL/GEOPHIRES-v2.git

This will create the following .gitmodules file (assuming you aren't using other submodules already):

[submodule "GEOPHIRES-v2"]
	path = GEOPHIRES-v2
	url = git@github.com:NREL/GEOPHIRES-v2.git

Your file structure may then look like the following:

my-geophires-project/
│
├── GEOPHIRES-v2/
│   ├── __init__.py
│   ├── GEOPHIRES-v2.py
│   └── ...
|── data/
│   ├── my-geophires-inputs.txt
│   ├── results/
├── .gitmodules
├── my_geophires_project.py

You can then consume GEOPHIRES programmatically by importing it as a module in my_geophires_project.py:

import os

GEOPHIRES_v2 = __import__('GEOPHIRES-v2.GEOPHIRESv2') # Note dash in package name necessitates use of __import__ instead of standard import syntax
geophires = GEOPHIRES_v2.GEOPHIRESv2

if __name__ == '__main__':
    geophires.run_geophires(
        input_file_path=os.path.join('data', 'my-geophires-inputs.txt'),
        output_file_path=os.path.join(
            'data',
            'results',
            'my-geophires-output.out'),
    )

Contact

In case of questions, comments, or suggestions for improvement or collaboration, please contact Koenraad Beckers (koenraad.beckers@heateon.com) or Kevin McCabe (kevin.mccabe@nrel.gov).

License

Version

GEOPHIRES v2.0 Build Date: December 9, 2018

softwareengineerprogrammer/GEOPHIRES-v2