mcpField
P
pygimli

pygimli

github.com/steadfastasartData & databases7361 installsUpdated 6w ago
Repository

About pygimli

pygimli is a Python toolkit for near-surface geophysical modeling and inversion, suited to electrical resistivity tomography and seismic refraction data. It provides meshes, data containers, and method-specific managers, with result visualization and export.

Key features

  1. 01Finite-element meshes and data containers
  2. 02Electrical resistivity processing and inversion
  3. 03Seismic refraction inversion
  4. 04Create custom meshes
  5. 05Save models and export VTK

Use cases

  1. 01Invert and inspect electrical resistivity measurements
  2. 02Process seismic refraction travel-time data
  3. 03Export meshes and models for viewing in ParaView

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/steadfastasart/geoscience-skills --skill pygimli

After installing, type/pygimliin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
mesh.md
methods.md
scripts/
ert_inversion.py

Details

From the project README

pyGIMLi - Geophysical Inversion

Quick Reference

import pygimli as pg
from pygimli.physics import ert, srt

# Load ERT data
data = ert.load("survey.ohm")

# Invert
mgr = ert.ERTManager(data)
model = mgr.invert(lam=20, verbose=True)

# View result
mgr.showResult()

Key Classes

ClassPurpose
pg.MeshFinite element meshes
pg.DataContainerSurvey data and geometry
pg.InversionBase inversion framework
ert.ERTManagerERT processing and inversion
srt.SRTManagerSeismic refraction inversion

Essential Operations

Load and View ERT Data
import pygimli as pg
from pygimli.physics import ert

data = ert.load("survey.ohm")
print(f"Measurements: {data.size()}")
ert.showData(data)  # Pseudosection
ERT Inversion
from pygimli.physics import ert

mgr = ert.ERTManager(data)
model = mgr.invert(
    lam=20,          # Regularization
    verbose=True
)
mgr.showResult()
resistivity = mgr.model
Seismic Refraction
from pygimli.physics import srt

data = srt.load("traveltimes.sgt")
mgr = srt.SRTManager(data)
model = mgr.invert(lam=30, zWeight=0.3)
mgr.showResult()
Create Custom Mesh
import pygimli as pg
from pygimli.physics import ert

data = ert.load("survey.ohm")
mesh = pg.meshtools.createParaMesh(
    data.sensors(),
    quality=34.0,
    paraMaxCellSize=5,
    boundary=2
)
pg.show(mesh)
Save and Export
# Save mesh and model
mgr.mesh.save("result_mesh.bms")
pg.save(model, "resistivity_model.vector")

# Export to VTK for ParaView
mgr.mesh.exportVTK("result", mgr.model)

Array Types

CodeArray
waWenner-alpha
wbWenner-beta
ddDipole-dipole
pdPole-dipole
ppPole-pole
slmSchlumberger
grGradient

Data Formats

FormatExtensionDescription
BERT/pyGIMLi.ohmUnified data format
Syscal.txtIRIS export
Res2DInv.dat2D inversion format
ABEM.ohmABEM Terrameter
SRT.sgtSeismic traveltimes

When to Use vs Alternatives

ScenarioRecommendation
Standard ERT inversion with common arrayspyGIMLi - simplest API, built-in array types
Seismic refraction tomography (SRT)pyGIMLi - integrated SRT manager
Multi-method inversion (DC, magnetics, gravity, EM)SimPEG - broader method coverage
Commercial ERT processing with reportingRes2DInv - industry standard, GUI-based
Custom forward operators or research flexibilitySimPEG - more modular design
FEM-based geophysical modellingpyGIMLi - native FEM mesh support

Choose pyGIMLi when: You need near-surface geophysical inversion (ERT, SRT, IP) with minimal code. Its manager classes (ERTManager, SRTManager) handle the full workflow from data loading to inversion to visualization in a few lines.

Avoid pyGIMLi when: You need methods beyond near-surface (use SimPEG), or you require a commercial-grade reporting pipeline.

Common Workflows

ERT data inversion and visualization
  • Load ERT data file with ert.load("survey.ohm")
  • Inspect data: check measurement count with data.size(), plot pseudosection
  • Remove outliers or bad data points
  • Create ERTManager with data
  • Run inversion: mgr.invert(lam=20) (start with higher lambda)
  • Check chi-squared value (target ~ 1)
  • Visualize result with mgr.showResult()
  • Export mesh and model to VTK for ParaView: mgr.mesh.exportVTK()
  • Adjust lambda and zWeight if needed, re-invert

Inversion Tips

  1. Start with higher lambda (50-100) and decrease
  2. Check data quality - remove outliers before inversion
  3. Use zWeight < 1 for layered structures
  4. Check coverage - low coverage = poorly resolved
  5. Chi-squared ~ 1 indicates good fit without overfitting

References

Scripts

Comments

Markdown supported