Installation

Requirements

PyGeoN requires:

  • Python >= 3.12

  • PorePy (accessible in your PYTHONPATH)

Basic Installation

To install PyGeoN in editable mode:

pip install -e .

For a regular installation (non-editable):

pip install .

Adding to PYTHONPATH

It might be useful to add PyGeoN to your PYTHONPATH.

On Linux/macOS, add this to your .bashrc or .zshrc:

export PYTHONPATH="${PYTHONPATH}:/path/to/pygeon/src"

Dependencies

PyGeoN depends on:

  • PorePy (development and testing versions)

  • NumPy

  • SciPy

  • Other dependencies are automatically installed via the PorePy installation

Verification

To verify your installation:

import pygeon as pg
print(pg.__version__)

Development Installation

For development, install with additional testing dependencies:

pip install -e ".[development,testing]"