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.1 -m "Releasing v26.2.1"
git push origin --tags
gh release create v26.2.0

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.3.tar.gz (22.8 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.3-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: water_column_sonar_annotation-26.2.3.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","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.3.tar.gz
Algorithm Hash digest
SHA256 e8fe5fcaa45bc157dff1ff0bfa77521500f3d13d355dca75b261826b64708a78
MD5 fcf2aba101cc17b983522a9319597e14
BLAKE2b-256 50a50e08cc092dd629e50a1a6ba9fa8a598f6f5ff256716e62b071d718b096a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: water_column_sonar_annotation-26.2.3-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 07454d7af79d63417799604c5bfb92395bd4877f975f0a3e2ee1ca7cd580282e
MD5 c9d011fe0626b180a219ed91d03eb283
BLAKE2b-256 b36b2052eaab89854be6c06b80f5ed1890b702e48a2ba82ef21780e85bab3dbf

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