water-column-sonar-annotation 26.1.8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. tests/__init__.py +0 -0
  2. tests/astronomical/__init__.py +0 -0
  3. tests/astronomical/test_astronomical_manager.py +148 -0
  4. tests/conftest.py +60 -0
  5. tests/cruise/__init__.py +0 -0
  6. tests/cruise/test_cruise_manager.py +80 -0
  7. tests/geospatial/__init__.py +0 -0
  8. tests/geospatial/test_geospatial_manager.py +86 -0
  9. tests/record/test_echoview_record_manager.py +160 -0
  10. water_column_sonar_annotation/__init__.py +5 -0
  11. water_column_sonar_annotation/astronomical/__init__.py +5 -0
  12. water_column_sonar_annotation/astronomical/astronomical_manager.py +82 -0
  13. water_column_sonar_annotation/cruise/__init__.py +5 -0
  14. water_column_sonar_annotation/cruise/cruise_manager.py +104 -0
  15. water_column_sonar_annotation/geospatial/__init__.py +5 -0
  16. water_column_sonar_annotation/geospatial/geospatial_manager.py +143 -0
  17. water_column_sonar_annotation/record/__init__.py +9 -0
  18. water_column_sonar_annotation/record/echoview_record_manager.py +426 -0
  19. water_column_sonar_annotation/record/graph_record_manager.py +82 -0
  20. water_column_sonar_annotation/record/parquet_record_manager.py +83 -0
  21. water_column_sonar_annotation/shape/__init__.py +5 -0
  22. water_column_sonar_annotation/shape/shape_manager.py +29 -0
  23. water_column_sonar_annotation-26.1.8.dist-info/METADATA +109 -0
  24. water_column_sonar_annotation-26.1.8.dist-info/RECORD +27 -0
  25. water_column_sonar_annotation-26.1.8.dist-info/WHEEL +5 -0
  26. water_column_sonar_annotation-26.1.8.dist-info/licenses/LICENSE +21 -0
  27. water_column_sonar_annotation-26.1.8.dist-info/top_level.txt +2 -0
@@ -0,0 +1,109 @@
1
+ Metadata-Version: 2.4
2
+ Name: water-column-sonar-annotation
3
+ Version: 26.1.8
4
+ Summary: Processing Tool for Working with Water Column Sonar Annotations
5
+ Author-email: Rudy Klucik <rudy.klucik@noaa.gov>
6
+ Maintainer-email: Rudy Klucik <rudy.klucik@noaa.gov>
7
+ License-Expression: MIT
8
+ Project-URL: Homepage, https://echo.fish
9
+ Project-URL: Repository, https://github.com/CI-CMG/water-column-sonar-annotation
10
+ Project-URL: Documentation, https://github.com/CI-CMG/water-column-sonar-annotation
11
+ Project-URL: Issues, https://github.com/CI-CMG/water-column-sonar-annotation/issues
12
+ Keywords: ocean,sonar,water column
13
+ Requires-Python: >=3.12
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: build
17
+ Requires-Dist: fiona
18
+ Requires-Dist: folium
19
+ Requires-Dist: geopandas
20
+ Requires-Dist: netcdf4
21
+ Requires-Dist: numpy
22
+ Requires-Dist: pandas
23
+ Requires-Dist: pandas-stubs
24
+ Requires-Dist: pooch
25
+ Requires-Dist: pvlib
26
+ Requires-Dist: pyarrow
27
+ Requires-Dist: pyogrio
28
+ Requires-Dist: python-dotenv
29
+ Requires-Dist: s3fs
30
+ Requires-Dist: scipy
31
+ Requires-Dist: shapely
32
+ Requires-Dist: setuptools
33
+ Requires-Dist: timezonefinder
34
+ Requires-Dist: xarray
35
+ Requires-Dist: zarr
36
+ Dynamic: license-file
37
+
38
+ # Water Column Sonar Annotation
39
+
40
+ Tool for converting EVR files to annotated regions of interest in parquet format
41
+
42
+ ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/CI-CMG/water-column-sonar-annotation/test_action.yaml)
43
+ ![PyPI - Implementation](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)
44
+
45
+ # Setting up the Python Environment
46
+
47
+ > Python 3.12.12
48
+
49
+ # Installing Dependencies
50
+
51
+ ```
52
+ source .venv/bin/activate
53
+
54
+ uv pip install --upgrade pip
55
+
56
+ uv pip install -r pyproject.toml --all-extras
57
+
58
+ uv run pre-commit install
59
+ ```
60
+
61
+ # Pytest
62
+
63
+ ```
64
+ uv run pytest tests -W ignore::DeprecationWarning
65
+ ```
66
+
67
+ or
68
+ > uv run pytest tests/cruise --cov=water_column_sonar_annotation --cov-report term-missing
69
+
70
+ ```
71
+ uv run pre-commit install --allow-missing-config
72
+ # or
73
+ uv run pre-commit install
74
+ ```
75
+
76
+ # Test Coverage
77
+
78
+ TODO
79
+
80
+ # Tag a Release
81
+
82
+ Step 1 --> increment the semantic version in the zarr_manager.py "metadata" & the "pyproject.toml"
83
+
84
+ ```commandline
85
+ git tag -a v26.1.0 -m "Releasing v26.1.0"
86
+ git push origin --tags
87
+ gh release create v26.1.0
88
+ ```
89
+
90
+ # To Publish To PROD
91
+
92
+ ```commandline
93
+ uv build --no-sources
94
+ uv publish
95
+ ```
96
+
97
+ # UV Debugging
98
+
99
+ ```
100
+ uv lock --check
101
+ uv lock
102
+ uv sync --extra dev
103
+ #uv run pytest tests
104
+ ```
105
+
106
+ ## Annotation format
107
+
108
+ - https://roboflow.com/formats/coco-json
109
+ - https://www.v7labs.com/blog/coco-dataset-guide
@@ -0,0 +1,27 @@
1
+ tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ tests/conftest.py,sha256=vAypoNVgTu3Uj1JK_X63aM8c9WXZF5lpIr2oyXwHjCc,2099
3
+ tests/astronomical/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
+ tests/astronomical/test_astronomical_manager.py,sha256=AMjwCq07zCfq6-UVZuPuMI-WfWbTOHuE5CFzQvV_WMs,5069
5
+ tests/cruise/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
6
+ tests/cruise/test_cruise_manager.py,sha256=vvvw1DmCYeu1eL5RZWArXRqMYdiVZ-jrMBuxzxT67-0,2326
7
+ tests/geospatial/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
8
+ tests/geospatial/test_geospatial_manager.py,sha256=FH7EKTLc9IuaxuSu4a1ELF1Eag0PtLR3B2SmAsntyuo,2652
9
+ tests/record/test_echoview_record_manager.py,sha256=sypDHtwig48ObnKYpB2RYboTwsal1uln-IyCVwfL3Hc,9992
10
+ water_column_sonar_annotation/__init__.py,sha256=-PIqLf8FrVlRrJjCU15axf6lPIpZCK47nV6YVPwLO1o,155
11
+ water_column_sonar_annotation/astronomical/__init__.py,sha256=iWJIwLDD0uK9ZGBH1EkKFKXmAdtD-mYAbrWlibXAJFU,94
12
+ water_column_sonar_annotation/astronomical/astronomical_manager.py,sha256=pEpaa3Bjg9R1oqvlqEfMF5IY-oGEp9BtPaqaq_Mag4g,3060
13
+ water_column_sonar_annotation/cruise/__init__.py,sha256=G2lZmW1UaX2AmznB7qEFH4j6mNiNQxLsQmTeRFTenOM,76
14
+ water_column_sonar_annotation/cruise/cruise_manager.py,sha256=Y-6eeHobHor9ZY33nSyk_iTz-cGzVgoWXgwPkNI2JMM,3546
15
+ water_column_sonar_annotation/geospatial/__init__.py,sha256=wy7fP2g5vic7L3bHcpFzlMsW811ca2WfReTCeOzeRKk,88
16
+ water_column_sonar_annotation/geospatial/geospatial_manager.py,sha256=KKYJ0YtQRfdW5Y3AbJ5Z5HFOkvHHB-zls1GUKXt-DAY,5212
17
+ water_column_sonar_annotation/record/__init__.py,sha256=2OKbUE6xbLSY6LFSiEgqV9hTT6piOKzWHZiKXKaGqmw,261
18
+ water_column_sonar_annotation/record/echoview_record_manager.py,sha256=V7wwE6Dw2buVESGv4yB02RbR0tEkppxsX9SArKMITKo,20800
19
+ water_column_sonar_annotation/record/graph_record_manager.py,sha256=4PociGWsXeRmvMcmDqWhs86uZP6eolhjKLqRQ3VN40M,2348
20
+ water_column_sonar_annotation/record/parquet_record_manager.py,sha256=Q1pCDKfgKg4aQG2BPPqNK1rQEb1ZMXiAaw54KPM6-iU,2398
21
+ water_column_sonar_annotation/shape/__init__.py,sha256=Ssg9_cz1zkU42X-oy9FmnfcFtkl2ic5eCHRryG2hZoU,75
22
+ water_column_sonar_annotation/shape/shape_manager.py,sha256=9P3tjgBqL1gktWyHcaUfh-eXZDv9M0rAy1g6Qu2oSJA,514
23
+ water_column_sonar_annotation-26.1.8.dist-info/licenses/LICENSE,sha256=lz4IpJ5_adG3S0ali-WaIpQFVTnEAOucMDQPECUVEYw,1110
24
+ water_column_sonar_annotation-26.1.8.dist-info/METADATA,sha256=0GtvS2MZU_61u_H0owPK2FLmTGK93FNYEaApbT0e9lA,2731
25
+ water_column_sonar_annotation-26.1.8.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
26
+ water_column_sonar_annotation-26.1.8.dist-info/top_level.txt,sha256=WmW_0S58c1A0pgWNXbozKC-ahrBAfhiDSGv68kzC-VE,36
27
+ water_column_sonar_annotation-26.1.8.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (80.10.2)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Cooperative Institutes, Coastal and Marine Geophysics
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,2 @@
1
+ tests
2
+ water_column_sonar_annotation