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.5 -m "Releasing v26.2.5"
git push origin --tags
#gh release create v26.2.5

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

{
  "id": "8eca84de-2d78-4f62-be35-eccb579d0183",
  "version": 0,
  "name": "test"
}

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.3.1.tar.gz (23.2 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.3.1-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: water_column_sonar_annotation-26.3.1.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","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.3.1.tar.gz
Algorithm Hash digest
SHA256 43ee35d42f25e6bdb7f32086f9a48db3b8b0882c79ec6c266fa39cd0196aa342
MD5 dff069a86900105ad4286e5c995ba9ce
BLAKE2b-256 11090c949c4150ac8aa6a88d74a1fc7af55d3be15449b59447551e637559dcc6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: water_column_sonar_annotation-26.3.1-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e18aabea37f668cc850b57e8a3de2119ee79962a4dfc6dc6287aa8f6bb4d4cb3
MD5 75e5f546be171d18255d054c6d67ffa0
BLAKE2b-256 447af5d914d2b9d51981897cb054edc19504416803f7b92442e4366564f258d8

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