Installation

PyHydroGeophysX requires Python 3.8 or higher.

Install from PyPI

pip install pyhydrogeophysx

Install with geophysics engines (recommended)

pip install "pyhydrogeophysx[geophysics]"

Install from Source

git clone https://github.com/geohang/PyHydroGeophysX.git
cd PyHydroGeophysX
pip install -e .

Core Dependencies

pip install numpy scipy matplotlib tqdm

Optional Dependencies

• PyGIMLi for ERT/SRT forward and inversion

• SimPEG for TDEM/FDEM workflows

• RESIPY for field ERT data processing

• CuPy for GPU acceleration

• joblib for parallel CPU workflows

pip install pygimli simpeg resipy joblib
pip install cupy-cuda11x  # Replace with your CUDA version

Desktop App (Qt Workbench)

Prebuilt Windows and macOS bundles are published on GitHub Releases and need no Python environment. To run the workbench from a Python install instead:

pip install "pyhydrogeophysx[desktop]"
pyhydrogeophysx-workbench

See Desktop Workbench (Qt) for the full usage guide.

Verification

import PyHydroGeophysX as phg
print("PyHydroGeophysX version:", phg.__version__)