Installing NREL’s Geothermal Play Fairway Analysis¶

There are several ways to install geoPFA. We strongly recommend using a virtual environment to avoid conflicts with other packages and projects on your system.

Quick Start¶

Choose your preferred installation method:

Pixi (recommended for development) - Reproducible environments with exact dependency versions
pip - Standard Python package installation
Conda/Mamba - Conda ecosystem integration
Wheels - Pre-built distribution files

Installing with Pixi (recommended)¶

Pixi provides reproducible Python environments and is our recommended tool for development. It uses the pyproject.toml and pixi.lock files to ensure you have exactly the same dependencies as the development team.

Installation Steps¶

Install Pixi (skip if already installed)

Linux and macOS:

curl -fsSL https://pixi.sh/install.sh | sh

Windows (PowerShell):

powershell -ExecutionPolicy ByPass -c "irm -useb https://pixi.sh/install.ps1 | iex"

For more installation options, see pixi.sh.

Clone the repository (if you haven’t already)

git clone https://github.com/NatLabRockies/geoPFA
cd geoPFA

Activate the Pixi environment
```
pixi shell
```
You should see a (geoPFA) prefix in your terminal prompt, indicating the environment is active.

Verify the installation

Inside Python:

import geopfa
print(geopfa.__version__)

Installing with pip¶

Installing with PIP is the most basic way of installing a Python package, and it is typically used to build containers or with some environment manager such as virtualenv. geoPFA requires Python 3.11 or newer. You might need to install PIP if it is not already provided.

Inside your preferred environment manager

Upgrade pip:
```
python -m pip install --upgrade pip
```

Install geoPFA:

From PyPI (public projects available in PyPI):

python -m pip install geoPFA

From GitHub (latest):

python -m pip install "git+https://github.com/NatLabRockies/geoPFA"

From a local clone:

python -m pip install .

Verify the installation: