Skip to main content

Multi-view stereo reconstruction of underwater surfaces with refractive modeling

Project description

Experimental setup 3D surface reconstruction

PyPI Python CI License: MIT Dataset DOI

AquaMVS

Multi-view-stereo (MVS) reconstruction of underwater surfaces viewed through a flat water surface, with Snell's law refraction modeling.

Status

v1.3.5 released. AquaMVS is feature-complete for the v1.0 milestone and available on PyPI. The API is considered stable; breaking changes will follow semantic versioning.

What it does

AquaMVS is a companion library to AquaCal. It consumes calibration output and synchronized video from above-water cameras to produce time-series 3D surface reconstructions. The pipeline handles the unique challenge of cameras positioned in air observing underwater geometry, accounting for refraction at the air-water interface using Snell's law.

Key Features

  • Refractive ray casting through air-water interface (Snell's law)
  • Dual matching pathways: LightGlue (sparse) and RoMa v2 (dense) for different accuracy/speed tradeoffs
  • Multi-view depth fusion with geometric consistency filtering
  • Surface reconstruction (Poisson, heightfield, Ball Pivoting Algorithm)
  • Mesh export (PLY, OBJ, STL, GLTF) with simplification
  • Full CLI and Python API for pipeline users and custom workflow developers

Quick Start

from aquamvs import Pipeline

pipeline = Pipeline("config.yaml")
pipeline.run()

See the full documentation for configuration details, API reference, and examples.

Installation

AquaMVS requires several prerequisites (PyTorch, LightGlue, RoMa v2) to be installed first. AquaCal is installed automatically as a dependency.

See INSTALL.md for complete installation instructions.

Quick summary:

# 1. Install PyTorch from pytorch.org
pip install torch torchvision --index-url https://download.pytorch.org/whl/cu121

# 2. Install git-based prerequisites (LightGlue, RoMa v2)
pip install -r requirements-prereqs.txt

# 3. Install AquaMVS (pulls AquaCal automatically)
pip install aquamvs

Documentation

Full documentation is available at https://aquamvs.readthedocs.io/

Topics include:

  • Installation guide
  • Configuration reference
  • API documentation
  • Usage examples
  • Extension points for custom workflows

Citation

If you use AquaMVS in your research, please cite:

Lancaster, T. (2026). AquaMVS: Multi-view stereo reconstruction with refractive geometry.
GitHub: https://github.com/McGrathLab/AquaMVS
Example dataset: https://doi.org/10.5281/zenodo.18702024

License

AquaMVS is released under the MIT License. See LICENSE for details.

Third-party components and commercial use

AquaMVS vendors no third-party source code or model weights; all optional components are installed separately at the user's request. The out-of-the-box configuration is fully MIT/permissive: the default matcher is RoMa v2 (MIT) and the default feature extractor is ALIKED (BSD-3-Clause).

The optional SuperPoint extractor (reachable via LightGlue by setting extractor_type: superpoint) is provided under Magic Leap's non-commercial academic-research-only license. It is not a default. Commercial users should select ALIKED (BSD-3) or DISK (Apache-2.0) instead of SuperPoint.

See THIRD_PARTY_LICENSES.md for the full breakdown.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aquamvs-1.6.2.tar.gz (140.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aquamvs-1.6.2-py3-none-any.whl (123.3 kB view details)

Uploaded Python 3

File details

Details for the file aquamvs-1.6.2.tar.gz.

File metadata

  • Download URL: aquamvs-1.6.2.tar.gz
  • Upload date:
  • Size: 140.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aquamvs-1.6.2.tar.gz
Algorithm Hash digest
SHA256 a42dea8d3f98c476834b4c10780ed9c2d5f21f58fef9d3dcfe24c377ebe18c50
MD5 9a8eac663f7399ed8cfde7bcd3c70d3b
BLAKE2b-256 66ea18d27133be0fd767144acf4def3fe97d778ae9531c9ee356e8b202623e39

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquamvs-1.6.2.tar.gz:

Publisher: publish.yml on McGrathLab/AquaMVS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aquamvs-1.6.2-py3-none-any.whl.

File metadata

  • Download URL: aquamvs-1.6.2-py3-none-any.whl
  • Upload date:
  • Size: 123.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aquamvs-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a7dc4d867dd3517db91cc4ddcfb642cb4b58e53fa600f3ffd8fd04b5e00dabbe
MD5 5d6a0cfdca3289cbbae662e9d51059cf
BLAKE2b-256 9243fe1584133f06d5a018ea49b46b0cfc99a165403be08c5b1593533a9d431c

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquamvs-1.6.2-py3-none-any.whl:

Publisher: publish.yml on McGrathLab/AquaMVS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page