# SaltPy
## Open-Source Sonar Survey Processing for Solution-Mined Caverns

![SaltPy Logo](https://github.com/AgapitoInc/SaltPy/tree/main/img/SaltPy.svg)

SaltPy is an open-source, vendor-agnostic Python framework developed for processing, georeferencing, and visualizing sonar survey data from solution-mined caverns. The software addresses challenges associated with transforming proprietary sonar files or exports into spatially consistent, analysis-ready datasets suitable for engineering evaluation, GIS integration, and three-dimensional modeling.

SaltPy implements spherical-to-Cartesian coordinate transformations, enabling direct integration with common geospatial (GIS) environments. Cavern geometries are represented as point clouds using widely adopted geospatial data structures, promoting interoperability and long-term reproducibility. The framework also supports the generation of higher-order geometric products, including wireframe models, STL volumes, and volumetric cavern envelopes derived from voxel-based reconstruction with watertight repair utilities. These capabilities facilitate interactive three-dimensional visualization, interpretation, and export to common engineering formats.


## Getting Started

- [Installation & Setup](https://github.com/AgapitoInc/SaltPy/tree/main/docs/setup/installation.md)  
  Learn how to install SaltPy and set up your environment.

- [Examples](https://github.com/AgapitoInc/SaltPy/tree/main/docs/examples/wireframe-EXAMPLE.md)  
  Step-by-step use cases to help you get started.

- [API Reference](https://github.com/AgapitoInc/SaltPy/tree/main/docs/api/SonarPy.md)  
  Full reference for all functions and classes.
