PyHydroGeophysX#

PyHydroGeophysX turns hydrology model outputs into geophysical responses and inversions. Use this page as a start point for first-time setup, guided workflows, and agent tools.

Start Here#

Installation

Install the package and optional dependencies.

Installation
Quickstart

Run a small, realistic first example.

Quickstart
Tutorials

Follow task-oriented workflow walkthroughs.

Tutorials and Workflows
Examples Gallery

Browse full scripts with figures and outputs.

Examples Gallery
API Reference

Explore modules, classes, and functions.

API Reference
Agent Web App

Open the Streamlit app and agent usage guidance.

Agent Web App
Desktop Workbench

Download the Qt desktop app for Windows and macOS.

Desktop Workbench (Qt)
Environmental Geophysics Course

Explore open lectures, interactive topic apps, field missions, and practice questions.

https://geohang.github.io/environmental-geophysics/

User Journeys#

Hydrology -> ERT Workflow

Load MODFLOW or ParFlow output, convert with petrophysics, and run ERT workflows.

Hydrology to ERT
Hydrology -> TDEM Workflow

Build layered conductivity models and run TDEM forward and inversion steps.

Hydrology to EM (TDEM and FDEM)
Agents and LLM Workflows

Use language-guided workflows and the hosted Streamlit app.

Agent Workflows
Joint ERT + SRT Inversion

Couple ERT and SRT with structure constraints and geostatistics.

Joint ERT + SRT Inversion

New In This Release#

  • Dedicated SRTInversion and TimeLapseSRTInversion classes.

  • New FDEMForwardModeling and FDEMInversion workflow support.

  • Unified dispatcher: GeophysicalInversion for ert/srt/tdem/fdem/joint.

  • New JointERTSRTInversion with cross-gradient and geostatistical constraints.

  • Cross-method utilities in StructuralConstraint and PetrophysicalCoupling.

Quickstart Code#

import numpy as np
from PyHydroGeophysX.petrophysics import water_content_to_resistivity

wc = np.array([[0.22, 0.28], [0.31, 0.35]])
rho = water_content_to_resistivity(wc, rhos=100.0, n=2.0, porosity=0.3)
print(rho)

Web App and Desktop App#

Open the hosted app: pyhydrogeophysx.streamlit.app

Download the desktop workbench (Windows / macOS): GitHub Releases; usage guide: Desktop Workbench (Qt).

Citation#

If you use PyHydroGeophysX in your work, please cite:

  • Chen, Hang and Niu, Qifei and Wu, Yuxin, PyHydroGeophysX: An Extensible Open-Source Platform for Integrating Hydrological Models with Geophysical Measurements. SSRN. https://ssrn.com/abstract=6238293 and https://doi.org/10.2139/ssrn.6238293

  • Chen, H. (2026). A Generalizable Automated Geophysical Agent Workflow for Accessible Subsurface Hydrology Analysis. Big Data and Earth System, 100042.