sweepx 0.1.0__py3-none-any.whl

sweepx/__init__.py

@@ -0,0 +1,17 @@
+"""sweepx — install handle for the sweep engine.
+
+`sweepx` itself has no code: ``pip install sweepx`` pulls in ``sweep-solver``
+(the CUDA-enabled solver engine). Companion packages (``sweep-io``, ``sweep-nn``,
+…) are not published in this solver-only release.
+
+**Use ``import sweep``, not ``import sweepx``.**
+
+The Python module name is ``sweep`` (provided by the ``sweep-solver``
+distribution). The PyPI distribution name had to change because ``sweep``
+was already taken — this is the same pattern as ``scikit-learn`` →
+``import sklearn``.
+"""
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

sweepx-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shaowen Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

sweepx-0.1.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: sweepx
+Version: 0.1.0
+Summary: Install handle for the sweep engine: `pip install sweepx`, then `import sweep`.
+Author-email: Shaowen Wang <shaowen.wang@kaust.edu.sa>
+License: MIT
+Project-URL: Homepage, https://github.com/DeepWave-KAUST/sweepx
+Project-URL: Issues, https://github.com/DeepWave-KAUST/sweepx/issues
+Keywords: fwi,geophysics,seismic,wave-equation,meta-package
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sweep-solver <0.2,>=0.1
+
+# sweepx
+
+**One-line install for the [sweep](https://github.com/DeepWave-KAUST/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
+
+```bash
+pip install sweepx
+```
+
+This drags in:
+
+| Distribution    | Import name      | What it does                                              |
+|-----------------|------------------|-----------------------------------------------------------|
+| `sweep-solver`  | `sweep`          | Wave-equation engine: equations, propagators, operators   |
+| `sweep-io`      | `sweep_io`       | SEG-Y / HDF5 / shot-gather datasets                       |
+| `sweep-nn`      | `sweep_nn`       | Neural priors: SIREN, INRs, hash-encoding, reparam        |
+| `sweep-opt`     | `sweep_opt`      | Optimizers, line search, preconditioners, parameterization|
+| `sweep-loss`    | `sweep_loss`     | Misfit functionals (L2, W2, envelope, AWI, …)             |
+| `sweep-viz`     | `sweep_viz`      | Plotting helpers for wavefields, gradients, models        |
+| `sweep-preproc` | `sweep_preproc`  | Signal preprocessing                                      |
+| `sweep-tasks`   | `sweep_tasks`    | Task-runner CLI for FWI/LSRTM pipelines                   |
+| `sweep-runner`  | `sweep_runner`   | Job-submission helpers                                    |
+
+## Import
+
+After `pip install sweepx`, **import as `sweep`**, not `sweepx`:
+
+```python
+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:
+
+```bash
+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](LICENSE).

sweepx-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+sweepx/__init__.py,sha256=WwAvzc8gRvpraf0IcxuRon0Je5xehgkAxny9obLDJ1M,604
+sweepx-0.1.0.dist-info/LICENSE,sha256=Okci_9acr6XKdZZRdP1KwvwBzPBd1Wr2wYgLtCoLuMU,1069
+sweepx-0.1.0.dist-info/METADATA,sha256=1hN3tlpYHP9f6ed4Dzz_bHhDPjCvSPtt_oLjOHZFnGc,3514
+sweepx-0.1.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+sweepx-0.1.0.dist-info/top_level.txt,sha256=VeJ88RjMw5vwWafU2HGAWJNm5Nibi5a0EyzLQopSVrY,7
+sweepx-0.1.0.dist-info/RECORD,,

sweepx-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.2.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sweepx-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sweepx