Skip to content

Polish sonar-vision to production grade + realistic simulation scenarios#1

Merged
SuperInstance merged 1 commit into
mainfrom
polish/production-grade
Jul 5, 2026
Merged

Polish sonar-vision to production grade + realistic simulation scenarios#1
SuperInstance merged 1 commit into
mainfrom
polish/production-grade

Conversation

@SuperInstance

Copy link
Copy Markdown
Owner

This PR polishes the repo to match its actual scope and adds realistic end-to-end simulation tests.

Changes:

  • Fixes GitHub repo description.
  • Adds MIT LICENSE.
  • Updates all docs to match the real public API.
  • Exports missing public classes.
  • Fixes Sonar.ping parameter and two-way propagation loss.
  • Adds tests/test_simulation_scenarios.py and SIMULATION_TEST_REPORT.md.

Local pytest is unavailable; verification is delegated to CI.

- Fix GitHub repo description to match actual toolkit scope.
- Add MIT LICENSE file and license metadata in pyproject.toml.
- Update README/API_REFERENCE/GETTING_STARTED/ARCHITECTURE/LOW_LEVEL/PLUG_AND_PLAY
  to reflect the real public API and remove non-existent methods.
- Export Detection, Track, Obstacle, CellState, PingResult from sonar_vision.
- Make Sonar.ping parameter name match README (distance) and correct active
  sonar to use two-way transmission loss.
- Add tests/test_simulation_scenarios.py: realistic multi-target underwater
  scene exercising Sonar -> ObjectTracker -> SpatialMap pipeline.
- Add SIMULATION_TEST_REPORT.md documenting scenario, findings, and gaps.

Local pytest is unavailable; full suite was verified with a temporary shim
and will be confirmed by GitHub Actions CI.
@SuperInstance SuperInstance merged commit 714672f into main Jul 5, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant