Skip to content

Examples

All examples on GitHub — examples/ (clone, run, modify)

Runnable example scripts and notebooks live in the examples/ directory of the repository. The notebooks under docs/notebooks/ are cell-by-cell tutorials and the easiest entry point; they are grouped by topic below. Scripts for workflows that don't fit a notebook (e.g. multi-process multi-GPU FWI) are linked at the bottom of this page.

Notebooks

New here? Start with Hello · SWEEP

The smallest end-to-end SWEEP story in one notebook: parameters → model → Acoustic() + PropTorch() → one shot gather → one .backward() for a vp gradient → 5-line Adam loop. No external data. Open notebook

  • FWI

    FWI


    Acoustic, variable-density and elastic Marmousi, multiscale and frequency-selection encoding, batched streamer windows, 3-D Overthrust.

    7 notebooks

  • NN · FWI

    NN · FWI


    A neural network produces the velocity model; its weights are inverted through the propagator.

    1 notebook

  • Wavefields

    Wavefields


    Elastic sources, DAS, topography, per-edge free surfaces, attenuation, poroelastic waves and solver settings.

    9 notebooks

  • Anisotropic

    Anisotropic


    Pseudo-acoustic VTI, pure-qP Born and LSRTM, rotated staggered-grid TTI in 2-D and 3-D, and the displacement formulation.

    5 notebooks

  • SEM

    SEM


    The spectral-element solver: forward and backward, topography against finite differences, and Marmousi FWI.

    4 notebooks

  • Imaging

    Imaging


    RTM, custom imaging conditions, the reflection-FWI gradient, and angle-domain gathers.

    5 notebooks

  • HPC

    HPC


    Memory strategies, boundary compression, multi-GPU data parallel, and domain decomposition.

    5 notebooks

  • Extending

    Extending


    Add a wave equation of your own and run it like a built-in.

    1 notebook

  • Sensitivity & resolution

    Sensitivity & resolution


    Radiation patterns and sensitivity kernels behind multiparameter trade-off, acoustic to poroelastic.

    4 notebooks

Scripts

For workflows that don't fit a single notebook — e.g. multi-process multi-GPU FWI — see:

Browse examples/ on GitHub for the full collection of runnable scripts.