Metadata-Version: 2.4
Name: water-column-sonar-annotation
Version: 26.2.1
Summary: Processing Tool for Working with Water Column Sonar Annotations
Author-email: Rudy Klucik <rudy.klucik@noaa.gov>
Maintainer-email: Rudy Klucik <rudy.klucik@noaa.gov>
License-Expression: MIT
Project-URL: Homepage, https://echo.fish
Project-URL: Repository, https://github.com/CI-CMG/water-column-sonar-annotation
Project-URL: Documentation, https://github.com/CI-CMG/water-column-sonar-annotation
Project-URL: Issues, https://github.com/CI-CMG/water-column-sonar-annotation/issues
Keywords: ocean,sonar,water column
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: build
Requires-Dist: fiona
Requires-Dist: folium
Requires-Dist: geopandas
Requires-Dist: netcdf4
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pandas-stubs
Requires-Dist: pooch
Requires-Dist: pvlib
Requires-Dist: pyarrow
Requires-Dist: pyogrio
Requires-Dist: pyspark
Requires-Dist: python-dotenv
Requires-Dist: s3fs
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: setuptools
Requires-Dist: timezonefinder
Requires-Dist: xarray
Requires-Dist: zarr
Dynamic: license-file

# Water Column Sonar Annotation

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

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/CI-CMG/water-column-sonar-annotation/test_action.yaml)
![PyPI - Version](https://img.shields.io/pypi/v/water-column-sonar-annotation) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/CI-CMG/water-column-sonar-annotation) ![GitHub repo size](https://img.shields.io/github/repo-size/CI-CMG/water-column-sonar-annotation)

# 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"

```commandline
git tag -a v26.2.0 -m "Releasing v26.2.0"
git push origin --tags
gh release create v26.2.0
```

# To Publish To PROD

```commandline
uv build --no-sources
uv publish
```

# UV Debugging

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

## Annotation format

- https://roboflow.com/formats/coco-json
- https://www.v7labs.com/blog/coco-dataset-guide
