Skip to content

SWEEP

Seismic Wave Equation Exploration Platform (SWEEP) is a Python package for seismic wave-equation modeling, propagation, and inversion.

What SWEEP Provides

  • Various wave equations (acoustic, elastic, visco-acoustic, etc.) in a unified framework
  • PyTorch and JAX backends
  • Optional PyTorch CUDA bindings for faster propagation (Boundary saving is supported)
  • Tools for forward modeling, FWI, and research prototyping
  • A modular structure for extending equations and operators

Documentation Map

  • Start with Installation to set up the package
  • Continue with Quick Start for a minimal example
  • See Backends for JAX, PyTorch, and CUDA binding notes
  • Use CLI to inspect supported equations from the terminal
  • Browse Examples for runnable scripts in the repository

Suggested Writing Plan

  • Fill in installation and environment requirements first
  • Add one minimal PyTorch example and one JAX example
  • Document equation classes and required model parameters
  • Add backend capability notes and performance guidance
  • Link each example page to the corresponding file in examples/