API REFERENCE · V0.0.1

The whole surface area.

Every public symbol in sweep. Click any equation to see its constructor, fields, and example usage. All pages render directly from Python docstrings via mkdocstrings.

33 equation classes 2 propagators PML + sponge boundaries torch · jax

Acoustic

6 classes

Constant-density acoustic wave equation. Most-used family; default for FWI.

Elastic

2 classes

Particle velocities and stresses. Required for converted-wave physics.

Anisotropic

2 classes

TTI elastic media with rotated symmetry axis. Required when tilted shales / layering matter.

DAS family

8 classes

Distributed-acoustic-sensing strain / strain-rate operators on top of the elastic wavefield. Zhao, Mu, Elastic, and Modeler formulations; 2D + 3D.

Propagators

2 classes

Wrap any equation into a callable solver. Equation-agnostic; same API for every physics family above.