Skip to main content

Processing Tool for Working with Water Column Sonar Annotations

Project description

Water Column Sonar Annotation

Tool for converting EVR files to annotated regions of interest in parquet format

GitHub Actions Workflow Status PyPI - Version GitHub code size in bytes GitHub repo size

Echoview documentation

https://support.echoview.com/WebHelp/Reference/File_Formats/Export_File_Formats/2D_Region_definition_file_format.htm

Annotations Download

Annotations are available at the first tagged version of this repo: https://github.com/CI-CMG/water-column-sonar-annotation/releases/tag/v26.1.0

Setting up the Python Environment

Python 3.12.12

Installing Dependencies

source .venv/bin/activate

uv pip install --upgrade pip

uv pip install -r pyproject.toml --all-extras

uv run pre-commit install

Pytest

uv run pytest tests -W ignore::DeprecationWarning

or

uv run pytest tests/cruise --cov=water_column_sonar_annotation --cov-report term-missing

uv run pre-commit install --allow-missing-config
# or
uv run pre-commit install

Test & Coverage

TODO

Tag a Release

Step 1 --> increment the semantic version in the zarr_manager.py "metadata" & the "pyproject.toml"

git tag -a v26.2.4 -m "Releasing v26.2.4"
git push origin --tags
gh release create v26.2.4

To Publish To PROD

uv build --no-sources
uv publish

UV Debugging

uv lock --check
uv lock
uv sync --extra dev
#uv run pytest tests

Annotation format

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

water_column_sonar_annotation-26.2.5.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

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

water_column_sonar_annotation-26.2.5-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

Details for the file water_column_sonar_annotation-26.2.5.tar.gz.

File metadata

  • Download URL: water_column_sonar_annotation-26.2.5.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for water_column_sonar_annotation-26.2.5.tar.gz
Algorithm Hash digest
SHA256 5d3cf5c1c89186301f0a9bfa0ee23adab2696cd38cf1ef53e07b8723726a921b
MD5 fae12370c0e1524b8855923de177990c
BLAKE2b-256 b807caeb2d3f9a762e8ac6e4c36d668fc75de81e0bc575258eb6406c491978a4

See more details on using hashes here.

File details

Details for the file water_column_sonar_annotation-26.2.5-py3-none-any.whl.

File metadata

  • Download URL: water_column_sonar_annotation-26.2.5-py3-none-any.whl
  • Upload date:
  • Size: 28.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for water_column_sonar_annotation-26.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e3187fae17c2419076302258a7615d18d68430749cb786f31d53614fc4a1f8ca
MD5 36efdbd8b5e9fec5ee8f7cf8b45b3456
BLAKE2b-256 2e89019edf7106992c9a8e9bc20490324eb0037d2f242700cf9ff99a231a268d

See more details on using hashes here.

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