sweepx

One-line install for the sweep ecosystem.

sweepx is an umbrella meta-package. It contains no code of its own — installing it just pulls in the solver plus every companion package in one shot.

Install

pip install sweepx

This drags in:

Import

After pip install sweepx, import as sweep, not sweepx:

import sweep                                  # the wave-equation engine
from sweep import equations, propagator       # native submodules
from sweep import io, nn, opt, loss, viz      # companion namespace aliases
from sweep_io import SEGYReader               # or use the real names directly

The sweep.io / sweep.nn / … short aliases are provided by sweep-solver's top-level __init__.py and resolve lazily to the underlying companion distributions.

This is the same pattern as pip install scikit-learn followed by import sklearn. The PyPI distribution name and the Python module name deliberately differ — sweep (the import name) was taken on PyPI, so the umbrella is published as sweepx.

CUDA

sweep-solver ships with optional CUDA kernels. To build them:

SWEEP_BUILD_CUDA=1 pip install sweepx

(Triggers a source build of the sweep._C extension. Requires PyTorch and the CUDA toolkit on PATH.)

License

MIT — see LICENSE.