water-column-sonar-processing 0.0.5__py3-none-any.whl → 0.0.6__py3-none-any.whl

water_column_sonar_processing/utility/constants.py

@@ -14,43 +14,50 @@ class Coordinates(Enum):
         long_name — most readable description of variable
         standard_name — name in lowercase and snake_case
     """
-    PROJECT_NAME = 'echofish'
 
-    DEPTH = 'depth'
-    DEPTH_DTYPE = 'float32'
-    DEPTH_UNITS = 'm'  # TODO: Pint? <https://pint.readthedocs.io/en/stable/>
-    DEPTH_LONG_NAME = 'Depth below surface'
-    DEPTH_STANDARD_NAME = 'depth'
+    PROJECT_NAME = "echofish"
 
-    TIME = 'time'
-    TIME_DTYPE = 'float64'
+    DEPTH = "depth"
+    DEPTH_DTYPE = "float32"
+    DEPTH_UNITS = "m"  # TODO: Pint? <https://pint.readthedocs.io/en/stable/>
+    DEPTH_LONG_NAME = "Depth below surface"
+    DEPTH_STANDARD_NAME = "depth"
+
+    TIME = "time"
+    TIME_DTYPE = "float64"
     # Note: units and calendar are used downstream by Xarray
-    TIME_UNITS = 'seconds since 1970-01-01 00:00:00'
-    TIME_LONG_NAME = 'Timestamp of each ping'
-    TIME_STANDARD_NAME = 'time'
-    TIME_CALENDAR = 'proleptic_gregorian'
+    TIME_UNITS = "seconds since 1970-01-01 00:00:00"
+    TIME_LONG_NAME = "Timestamp of each ping"
+    TIME_STANDARD_NAME = "time"
+    TIME_CALENDAR = "proleptic_gregorian"
     # TODO: create test for reading out timestamps in Xarray
 
-    FREQUENCY = 'frequency'
-    FREQUENCY_DTYPE = 'int'
-    FREQUENCY_UNITS = 'Hz'
-    FREQUENCY_LONG_NAME = 'Transducer frequency'
-    FREQUENCY_STANDARD_NAME = 'sound_frequency'
-
-    LATITUDE = 'latitude'
-    LATITUDE_DTYPE = 'float32'
-    LATITUDE_UNITS = 'degrees_north'
-    LATITUDE_LONG_NAME = 'Latitude'
-    LATITUDE_STANDARD_NAME = 'latitude'
-
-    LONGITUDE = 'longitude'
-    LONGITUDE_DTYPE = 'float32'
-    LONGITUDE_UNITS = 'degrees_east'
-    LONGITUDE_LONG_NAME = 'Longitude'
-    LONGITUDE_STANDARD_NAME = 'longitude'
-
-    SV = 'Sv'
-    SV_DTYPE = 'float32'  # TODO: experiment with dtype of int
-    SV_UNITS = 'dB'
-    SV_LONG_NAME = 'Volume backscattering strength (Sv re 1 m-1)'
-    SV_STANDARD_NAME = 'volume_backscattering_strength'
+    FREQUENCY = "frequency"
+    FREQUENCY_DTYPE = "int"
+    FREQUENCY_UNITS = "Hz"
+    FREQUENCY_LONG_NAME = "Transducer frequency"
+    FREQUENCY_STANDARD_NAME = "sound_frequency"
+
+    LATITUDE = "latitude"
+    LATITUDE_DTYPE = "float32"
+    LATITUDE_UNITS = "degrees_north"
+    LATITUDE_LONG_NAME = "Latitude"
+    LATITUDE_STANDARD_NAME = "latitude"
+
+    LONGITUDE = "longitude"
+    LONGITUDE_DTYPE = "float32"
+    LONGITUDE_UNITS = "degrees_east"
+    LONGITUDE_LONG_NAME = "Longitude"
+    LONGITUDE_STANDARD_NAME = "longitude"
+
+    BOTTOM = "bottom"
+    BOTTOM_DTYPE = "float32"
+    BOTTOM_UNITS = "m"
+    BOTTOM_LONG_NAME = "Detected sea floor depth"
+    BOTTOM_STANDARD_NAME = "bottom"
+
+    SV = "Sv"
+    SV_DTYPE = "float32"  # TODO: experiment with dtype of int
+    SV_UNITS = "dB"
+    SV_LONG_NAME = "Volume backscattering strength (Sv re 1 m-1)"
+    SV_STANDARD_NAME = "volume_backscattering_strength"

water_column_sonar_processing/utility/pipeline_status.py

@@ -16,13 +16,17 @@ class PipelineStatus(Flag):
     PROCESSING_RAW_PROCESSOR = auto()
     FAILURE_RAW_PROCESSOR = auto()
     SUCCESS_RAW_PROCESSOR = auto()
-    RAW_PROCESSOR = PROCESSING_RAW_PROCESSOR | FAILURE_RAW_PROCESSOR | SUCCESS_RAW_PROCESSOR
+    RAW_PROCESSOR = (
+        PROCESSING_RAW_PROCESSOR | FAILURE_RAW_PROCESSOR | SUCCESS_RAW_PROCESSOR
+    )
     #
     # RAW_AGGREGATOR --> AGGREGATOR (Scatter-Gather EIP)
     PROCESSING_RAW_AGGREGATOR = auto()
     FAILURE_RAW_AGGREGATOR = auto()
     SUCCESS_RAW_AGGREGATOR = auto()
-    RAW_AGGREGATOR = PROCESSING_RAW_AGGREGATOR | FAILURE_RAW_AGGREGATOR | SUCCESS_RAW_AGGREGATOR
+    RAW_AGGREGATOR = (
+        PROCESSING_RAW_AGGREGATOR | FAILURE_RAW_AGGREGATOR | SUCCESS_RAW_AGGREGATOR
+    )
     #
     LEVEL_1_PROCESSING = RAW_SPLITTER | RAW_PROCESSOR | RAW_AGGREGATOR
     #
@@ -35,27 +39,43 @@ class PipelineStatus(Flag):
     PROCESSING_CRUISE_INITIALIZER = auto()
     FAILURE_CRUISE_INITIALIZER = auto()
     SUCCESS_CRUISE_INITIALIZER = auto()
-    CRUISE_INITIALIZER = PROCESSING_CRUISE_INITIALIZER | FAILURE_CRUISE_INITIALIZER | SUCCESS_CRUISE_INITIALIZER
+    CRUISE_INITIALIZER = (
+        PROCESSING_CRUISE_INITIALIZER
+        | FAILURE_CRUISE_INITIALIZER
+        | SUCCESS_CRUISE_INITIALIZER
+    )
     #
     # CRUISE_SPLITTER --> SPLITTER
     PROCESSING_CRUISE_SPLITTER = auto()
     FAILURE_CRUISE_SPLITTER = auto()
     SUCCESS_CRUISE_SPLITTER = auto()
-    CRUISE_SPLITTER = PROCESSING_CRUISE_SPLITTER | FAILURE_CRUISE_SPLITTER | SUCCESS_CRUISE_SPLITTER
+    CRUISE_SPLITTER = (
+        PROCESSING_CRUISE_SPLITTER | FAILURE_CRUISE_SPLITTER | SUCCESS_CRUISE_SPLITTER
+    )
     #
     # CRUISE_PROCESSOR --> PROCESSOR <-- Note: these need to run sequentially now
     PROCESSING_CRUISE_PROCESSOR = auto()
     FAILURE_CRUISE_PROCESSOR = auto()
     SUCCESS_CRUISE_PROCESSOR = auto()
-    CRUISE_PROCESSOR = PROCESSING_CRUISE_PROCESSOR | FAILURE_CRUISE_PROCESSOR | SUCCESS_CRUISE_PROCESSOR
+    CRUISE_PROCESSOR = (
+        PROCESSING_CRUISE_PROCESSOR
+        | FAILURE_CRUISE_PROCESSOR
+        | SUCCESS_CRUISE_PROCESSOR
+    )
     #
     # CRUISE_AGGREGATOR --> AGGREGATOR
     PROCESSING_CRUISE_AGGREGATOR = auto()
     FAILURE_CRUISE_AGGREGATOR = auto()
     SUCCESS_CRUISE_AGGREGATOR = auto()
-    CRUISE_AGGREGATOR = PROCESSING_CRUISE_AGGREGATOR | FAILURE_CRUISE_AGGREGATOR | SUCCESS_CRUISE_AGGREGATOR
+    CRUISE_AGGREGATOR = (
+        PROCESSING_CRUISE_AGGREGATOR
+        | FAILURE_CRUISE_AGGREGATOR
+        | SUCCESS_CRUISE_AGGREGATOR
+    )
     #
-    LEVEL_2_PROCESSING = CRUISE_INITIALIZER | CRUISE_SPLITTER | CRUISE_PROCESSOR | CRUISE_AGGREGATOR
+    LEVEL_2_PROCESSING = (
+        CRUISE_INITIALIZER | CRUISE_SPLITTER | CRUISE_PROCESSOR | CRUISE_AGGREGATOR
+    )
     #
     # --------------------------------------------------- #
     # --- Level 3 Data ---------------------------------- #
@@ -64,18 +84,25 @@ class PipelineStatus(Flag):
     PROCESSING_TILE_PROCESSOR = auto()
     FAILURE_TILE_PROCESSOR = auto()
     SUCCESS_TILE_PROCESSOR = auto()
-    TILE_PROCESSOR = PROCESSING_TILE_PROCESSOR | FAILURE_TILE_PROCESSOR | SUCCESS_TILE_PROCESSOR
+    TILE_PROCESSOR = (
+        PROCESSING_TILE_PROCESSOR | FAILURE_TILE_PROCESSOR | SUCCESS_TILE_PROCESSOR
+    )
     #
     # GEOHASH_PROCESSOR
     PROCESSING_GEOHASH_PROCESSOR = auto()
     FAILURE_GEOHASH_PROCESSOR = auto()
     SUCCESS_GEOHASH_PROCESSOR = auto()
-    GEOHASH_PROCESSOR = PROCESSING_GEOHASH_PROCESSOR | FAILURE_GEOHASH_PROCESSOR | SUCCESS_GEOHASH_PROCESSOR
+    GEOHASH_PROCESSOR = (
+        PROCESSING_GEOHASH_PROCESSOR
+        | FAILURE_GEOHASH_PROCESSOR
+        | SUCCESS_GEOHASH_PROCESSOR
+    )
     #
     LEVEL_3_PROCESSING = TILE_PROCESSOR | GEOHASH_PROCESSOR
     # --------------------------------------------------- #
     # --------------------------------------------------- #
 
+
 # Status.PROCESSING_RAW_AGGREGATOR in Status.LEVEL_1_PROCESSING
 # Status.LEVEL_1_PROCESSING.value < Status.LEVEL_2_PROCESSING.value
 
@@ -95,4 +122,4 @@ failed - verb - "verbs should be avoided"
 
 success - noun
 
-"""
+"""

water_column_sonar_processing/utility/timestamp.py

@@ -7,6 +7,7 @@ class Timestamp:
     def get_timestamp():
         # return timestamp in form:
         #   PIPELINE_TIME = '2024-03-29T19:36:52.433Z'
-        return f'{datetime.utcnow().isoformat()[:23]}Z'
+        return f"{datetime.utcnow().isoformat()[:23]}Z"
 
-###########################################################
+
+###########################################################

{water_column_sonar_processing-0.0.5.dist-info → water_column_sonar_processing-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: water_column_sonar_processing
-Version: 0.0.5
+Version: 0.0.6
 Summary: A processing tool for water column sonar data.
 Author-email: Rudy Klucik <rudy.klucik@noaa.gov>
 Project-URL: Homepage, https://github.com/CI-CMG/water-column-sonar-processing
@@ -11,6 +11,26 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: aiobotocore~=2.9.0
+Requires-Dist: aiohttp~=3.10.10
+Requires-Dist: boto3==1.33.13
+Requires-Dist: botocore~=1.33.13
+Requires-Dist: echopype==0.9.0
+Requires-Dist: geopandas==1.0.1
+Requires-Dist: mock~=5.1.0
+Requires-Dist: moto~=5.0.18
+Requires-Dist: numcodecs==0.13.1
+Requires-Dist: numpy==1.26.4
+Requires-Dist: pandas==2.2.3
+Requires-Dist: pytest~=8.3.3
+Requires-Dist: python-dotenv==1.0.0
+Requires-Dist: requests==2.32.3
+Requires-Dist: s3fs==2024.10.0
+Requires-Dist: scipy==1.14.1
+Requires-Dist: shapely==2.0.3
+Requires-Dist: typing-extensions==4.10.0
+Requires-Dist: xarray==2022.12.0
+Requires-Dist: zarr==2.18.3
 
 # Water Column Sonar Processing
 Processing tool for converting L0 data to L1 and L2 as well as generating geospatial information
@@ -72,6 +92,8 @@ https://packaging.python.org/en/latest/tutorials/packaging-projects/
 # To Publish To TEST
 ```commandline
 python -m build
+# python -m build --sdist
+# python -m build --wheel
 python -m twine upload --repository testpypi dist/*
 pytho -m pip install --index-url https://test.pypi.org/simple/ hello-pypi-rudy-klucik
 python
@@ -87,7 +109,15 @@ python -m build
 python -m twine upload --repository pypi dist/*
 ```
 
+# Pre Commit Hook
+https://dev.to/rafaelherik/using-trufflehog-and-pre-commit-hook-to-prevent-secret-exposure-edo
+```
+pre-commit install --allow-missing-config
+```
 
 # Linting
 Ruff
 https://plugins.jetbrains.com/plugin/20574-ruff
+
+# Colab Test
+https://colab.research.google.com/drive/1KiLMueXiz9WVB9o4RuzYeGjNZ6PsZU7a#scrollTo=AayVyvpBdfIZ

water_column_sonar_processing-0.0.6.dist-info/RECORD

@@ -0,0 +1,29 @@
+water_column_sonar_processing/__init__.py,sha256=S11loSDNOmZRyiTMbTwiQ1PP59SSPq2q2P61e5gPrW4,295
+water_column_sonar_processing/process.py,sha256=AHoCehc95XqGI1IZkvfcbnYpjr8J-OQfCBGs0-1O9_w,5439
+water_column_sonar_processing/aws/__init__.py,sha256=u5J-TOEVgAQsMdc5LMo1igUESRclzV8gf-b0jUaJ9Gg,277
+water_column_sonar_processing/aws/dynamodb_manager.py,sha256=sPa_5RlTNjcFavZ74LF0UINKSyrbgJNROXbe16hCz7U,5936
+water_column_sonar_processing/aws/s3_manager.py,sha256=P-0ZFsa6D6obIy-iNnWF1BrcoHOfAvYM-Qn9cA0e5H0,13142
+water_column_sonar_processing/aws/s3fs_manager.py,sha256=thVJPQKhbvF1g-Ue3BYgwazFOFDYOICIEJx4zkXBQ1E,2381
+water_column_sonar_processing/aws/sns_manager.py,sha256=Dp9avG5VSugSWPR1dZ-askuAw1fCZkNUHbOUP65iR-k,1867
+water_column_sonar_processing/aws/sqs_manager.py,sha256=NSUrWmnSC8h8Gf7gT0U8zFaQQ-yX89h0Q0mDLKGqp2Y,1597
+water_column_sonar_processing/cruise/__init__.py,sha256=H5hW0JMORuaFvQk_R31B4VL8RnRyKeanOOiWmqEMZJk,156
+water_column_sonar_processing/cruise/create_empty_zarr_store.py,sha256=w2lxfPS2HRVlNCr6OWBRxIyGaPUnxAnWrYgmu0EgOL0,7275
+water_column_sonar_processing/cruise/resample_regrid.py,sha256=HeRN4EOZch-HhiK-s5LjX0bz4sKXKpea5YVIMEZOAGg,12356
+water_column_sonar_processing/geometry/__init__.py,sha256=_ol5nI8AL30pYXeAh5rtP7YmQggitPC6LA_kuTfPJ0Q,231
+water_column_sonar_processing/geometry/geometry_manager.py,sha256=RJ5pljMLqjNdJbc8Q0s-HGphMy6B7e_7R7ZZfdxEY-k,9913
+water_column_sonar_processing/geometry/geometry_simplification.py,sha256=im1HG9nfYIerQv3w-PUHzphw2B7aGgnsA3Zcdy2oTmA,3016
+water_column_sonar_processing/geometry/pmtile_generation.py,sha256=KI5y3CVBXSrxYoenQPHBUhPPAvcw1bkqCg1LZ9xvlzY,2772
+water_column_sonar_processing/index/__init__.py,sha256=izEObsKiOoIJ0kZCFhvaYsBd6Ga71XJxnogjrNInw68,68
+water_column_sonar_processing/index/index_manager.py,sha256=2D4mbWK2D3p0wsZqeoxieCtz9HsDkm5Mvt9u2t12BFI,11107
+water_column_sonar_processing/model/__init__.py,sha256=FXaCdbPqxp0ogmZm9NplRirqpgMiYs1iRYgJbFbbX2Y,65
+water_column_sonar_processing/model/zarr_manager.py,sha256=IvA2mTZ6YrfTKL3U6NVgmjeqYPUXMSI3V-HI5ESgAwg,13408
+water_column_sonar_processing/utility/__init__.py,sha256=nyqPobcvwftr6T4MNxNtQtfbWzW9Kgpbp6JO7Gr5IZI,206
+water_column_sonar_processing/utility/cleaner.py,sha256=jaNDHbZxqQv2I8VfFkbwlQoCtIHi1pQonqt3XtioVq0,585
+water_column_sonar_processing/utility/constants.py,sha256=qSuxPg4dnyI4DDXWc1OYqTBTChxZ9iWdUrFfqLtH21c,1793
+water_column_sonar_processing/utility/pipeline_status.py,sha256=O-0SySqdRGJ6bs3zQe1NV9vkOpmsRM7zj5QoHgzYioY,4395
+water_column_sonar_processing/utility/timestamp.py,sha256=bO0oir7KxxoEHPGRkz9FCBfOligkocUyRiWRzAq8fnU,361
+water_column_sonar_processing-0.0.6.dist-info/LICENSE,sha256=lz4IpJ5_adG3S0ali-WaIpQFVTnEAOucMDQPECUVEYw,1110
+water_column_sonar_processing-0.0.6.dist-info/METADATA,sha256=nQW75RMHtE7D1faQBnzZ2L9IL7hlAITv_oHfnur8D0Y,4109
+water_column_sonar_processing-0.0.6.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+water_column_sonar_processing-0.0.6.dist-info/top_level.txt,sha256=aRYU4A7RNBlNrL4vzjytFAir3BNnmOgsvIGKKA36tg4,30
+water_column_sonar_processing-0.0.6.dist-info/RECORD,,

water_column_sonar_processing-0.0.5.dist-info/RECORD

@@ -1,29 +0,0 @@
-water_column_sonar_processing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-water_column_sonar_processing/process.py,sha256=Wu3hcSbsB52gM8bAELKd0n206tdOTfzd3LDpFVCzhYg,5337
-water_column_sonar_processing/aws/__init__.py,sha256=pYvL00VjrwCe9k5jfof2k-nc9IG1N-hy1k95W7VlKOs,162
-water_column_sonar_processing/aws/dynamodb_manager.py,sha256=Z1-fhr2X6B_wIlIHMYPTgvwkhccYn75U2XZYNP2pJvI,5339
-water_column_sonar_processing/aws/s3_manager.py,sha256=IJb8hlMGZr5COs2CbOEZvJvRZHw3UN6cNft20soyqbw,13402
-water_column_sonar_processing/aws/s3fs_manager.py,sha256=k4nW48E0reQwj1t4pe_ybK5kX0H1SHeG8urddHelGZ4,2463
-water_column_sonar_processing/aws/sns_manager.py,sha256=IR5Y3MvwYFjd-eSg4tEjoNyABGxdJb85wOj0I-vckX0,2204
-water_column_sonar_processing/aws/sqs_manager.py,sha256=VQSkxYtdhH4zfZqQl5FiNE2_svczN0hU-UBgbviwvtc,1696
-water_column_sonar_processing/cruise/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-water_column_sonar_processing/cruise/create_empty_zarr_store.py,sha256=dkJzNZmD51TSphhWVq9qbO32L54ipXREYwT7DYCek_8,7039
-water_column_sonar_processing/cruise/resample_regrid.py,sha256=-YFSKljnuKqn8PkhmfhDwrQHuvziApJWwS-zU3l0ZO4,11327
-water_column_sonar_processing/geometry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-water_column_sonar_processing/geometry/geometry_manager.py,sha256=d6uKXsxcVfoDpVqr92YyRemLL9g-VDxCttjadPAKt34,9461
-water_column_sonar_processing/geometry/geometry_simplification.py,sha256=_TCrlxqWlhO05Od3ZB4Sfgob9p3tQr3r1vjseG0qMNQ,3071
-water_column_sonar_processing/geometry/pmtile_generation.py,sha256=sXKFKmSu33bOdPBmW5FHpMsKLf6SFlgv7QznqsJ_Ko4,2791
-water_column_sonar_processing/index/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-water_column_sonar_processing/index/index_manager.py,sha256=novA5ZutVkSU_miC1IYG1OCjUkxLBlbij68o87eCQz0,10732
-water_column_sonar_processing/model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-water_column_sonar_processing/model/zarr_manager.py,sha256=zNbrQAtNoszenfoJ6Y9TJzkcAAKJKEf4DXKMHAIdv_c,12452
-water_column_sonar_processing/utility/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-water_column_sonar_processing/utility/cleaner.py,sha256=oa6pt--HVrlCx6rSWkTbCQBSAlFushrOPzW4JT5fzTc,601
-water_column_sonar_processing/utility/constants.py,sha256=uTuSyH9YGG8bDd5xNbT4zA5O_lu874C-8m1MRvVppPw,1631
-water_column_sonar_processing/utility/pipeline_status.py,sha256=iRLyzI3gsesyz0I4NukbJwqiRmXgSZBOdB3C1x2eMSg,4185
-water_column_sonar_processing/utility/timestamp.py,sha256=i4ub7ob24edHU2yt4aOmvle_Nmlf1F_9HVGa9TJ5HgM,359
-water_column_sonar_processing-0.0.5.dist-info/LICENSE,sha256=lz4IpJ5_adG3S0ali-WaIpQFVTnEAOucMDQPECUVEYw,1110
-water_column_sonar_processing-0.0.5.dist-info/METADATA,sha256=gQwpPMJaL4v90Nk34OFi1XMM_LX3Yj320JKSYghjDWU,3157
-water_column_sonar_processing-0.0.5.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-water_column_sonar_processing-0.0.5.dist-info/top_level.txt,sha256=aRYU4A7RNBlNrL4vzjytFAir3BNnmOgsvIGKKA36tg4,30
-water_column_sonar_processing-0.0.5.dist-info/RECORD,,