# Water Column Sonar Processing
Processing tool for converting Level_0 water column sonar data to Level_1 and Level_2 derived data sets as well as generating geospatial information.
    
# Setting up the Python Environment
> Python 3.12.11
# 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 --cache-clear tests -W ignore::DeprecationWarning
```
or
> pytest --cache-clear --cov=src tests/ --cov-report=xml
# Instructions
Following this tutorial:
https://packaging.python.org/en/latest/tutorials/packaging-projects/
# Pre Commit Hook
see here for installation: https://pre-commit.com/
https://dev.to/rafaelherik/using-trufflehog-and-pre-commit-hook-to-prevent-secret-exposure-edo
```
uv run pre-commit install --allow-missing-config
# or
uv run pre-commit install
```
# Black
https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/
```
Settings > Black
Execution mode: Package
Python Interpreter: .../.venv/bin/python
Use Black Formatter: X On Code reformat, X On Save
```
# Linting
Ruff
https://plugins.jetbrains.com/plugin/20574-ruff
# Colab Test
https://colab.research.google.com/drive/1KiLMueXiz9WVB9o4RuzYeGjNZ6PsZU7a#scrollTo=AayVyvpBdfIZ
# 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 v25.8.0 -m "Releasing v25.8.0"
git push origin --tags
```
# To Publish To PROD
```
uv build --no-sources
uv publish
```
# TODO:
add https://pypi.org/project/setuptools-scm/
for extracting the version
# Security scanning
> bandit -r water_column_sonar_processing/
# Data Debugging
Experimental Plotting in Xarray (hvPlot):
https://colab.research.google.com/drive/18vrI9LAip4xRGEX6EvnuVFp35RAiVYwU#scrollTo=q9_j9p2yXsLV
HB0707 Zoomable Cruise:
https://hb0707.s3.us-east-1.amazonaws.com/index.html
# UV Debugging
```
uv lock --check
uv lock
uv sync --extra dev
```
# Fixing S3FS Problems
```commandline
To enable/disa asyncio for the debugger, follow the steps:
Open PyCharm
Use Shift + Shift (Search Everywhere)
In the popup type: Registry and press Enter
Find "Registry" in the list of results and click on it.
In the new popup find python.debug.asyncio.repl line and check the respective checkbox
Press Close.
Restart the IDE.
The asyncio support will be enabled in the debugger.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "water-column-sonar-processing",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "Rudy Klucik <rudy.klucik@noaa.gov>",
"keywords": "ocean, sonar, water column, zarr",
"author": null,
"author_email": "Rudy Klucik <rudy.klucik@noaa.gov>",
"download_url": "https://files.pythonhosted.org/packages/7c/ef/b57a053699e8d905edca3b9eb351e4b4ca89bfe848c5e185621fbd3ea243/water_column_sonar_processing-25.8.0.tar.gz",
"platform": null,
"description": "# Water Column Sonar Processing\nProcessing tool for converting Level_0 water column sonar data to Level_1 and Level_2 derived data sets as well as generating geospatial information.\n\n\n    \n\n# Setting up the Python Environment\n> Python 3.12.11\n\n# Installing Dependencies\n```\nsource .venv/bin/activate\n\nuv pip install --upgrade pip\n\nuv pip install -r pyproject.toml --all-extras\n\nuv run pre-commit install\n```\n\n# Pytest\n```\nuv run pytest --cache-clear tests -W ignore::DeprecationWarning\n```\nor\n> pytest --cache-clear --cov=src tests/ --cov-report=xml\n\n# Instructions\nFollowing this tutorial:\nhttps://packaging.python.org/en/latest/tutorials/packaging-projects/\n\n# Pre Commit Hook\nsee here for installation: https://pre-commit.com/\nhttps://dev.to/rafaelherik/using-trufflehog-and-pre-commit-hook-to-prevent-secret-exposure-edo\n```\nuv run pre-commit install --allow-missing-config\n# or\nuv run pre-commit install\n```\n\n# Black\nhttps://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/\n```\nSettings > Black\nExecution mode: Package\nPython Interpreter: .../.venv/bin/python\nUse Black Formatter: X On Code reformat, X On Save\n```\n\n# Linting\nRuff\nhttps://plugins.jetbrains.com/plugin/20574-ruff\n\n# Colab Test\nhttps://colab.research.google.com/drive/1KiLMueXiz9WVB9o4RuzYeGjNZ6PsZU7a#scrollTo=AayVyvpBdfIZ\n\n# Test Coverage\nTODO\n\n# Tag a Release\nStep 1 --> increment the semantic version in the zarr_manager.py \"metadata\" & the \"pyproject.toml\"\n```commandline\ngit tag -a v25.8.0 -m \"Releasing v25.8.0\"\ngit push origin --tags\n```\n\n# To Publish To PROD\n```\nuv build --no-sources\nuv publish\n```\n\n# TODO:\nadd https://pypi.org/project/setuptools-scm/\nfor extracting the version\n\n# Security scanning\n> bandit -r water_column_sonar_processing/\n\n# Data Debugging\nExperimental Plotting in Xarray (hvPlot):\nhttps://colab.research.google.com/drive/18vrI9LAip4xRGEX6EvnuVFp35RAiVYwU#scrollTo=q9_j9p2yXsLV\n\nHB0707 Zoomable Cruise:\nhttps://hb0707.s3.us-east-1.amazonaws.com/index.html\n\n\n# UV Debugging\n```\nuv lock --check\nuv lock\nuv sync --extra dev\n```\n\n# Fixing S3FS Problems\n```commandline\nTo enable/disa asyncio for the debugger, follow the steps:\nOpen PyCharm\nUse Shift + Shift (Search Everywhere)\nIn the popup type: Registry and press Enter\nFind \"Registry\" in the list of results and click on it.\nIn the new popup find python.debug.asyncio.repl line and check the respective checkbox\nPress Close.\nRestart the IDE.\nThe asyncio support will be enabled in the debugger.\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Processing tool for water column sonar data.",
"version": "25.8.0",
"project_urls": {
"Homepage": "https://echo.fish",
"Issues": "https://github.com/CI-CMG/water-column-sonar-processing/issues",
"Repository": "https://github.com/CI-CMG/water-column-sonar-processing"
},
"split_keywords": [
"ocean",
" sonar",
" water column",
" zarr"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "16ca574be84c909b81a4ec8721ff85fb2dc766d43b3bb9da0cf4091bc39866e4",
"md5": "e3ce51441ccec499b5a6a4df0d69b925",
"sha256": "6c88d9dcd16b0ea3515770ba4b137d16630ebe4db7f07308d51ad4271859bd44"
},
"downloads": -1,
"filename": "water_column_sonar_processing-25.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3ce51441ccec499b5a6a4df0d69b925",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 65986,
"upload_time": "2025-08-20T17:18:43",
"upload_time_iso_8601": "2025-08-20T17:18:43.226189Z",
"url": "https://files.pythonhosted.org/packages/16/ca/574be84c909b81a4ec8721ff85fb2dc766d43b3bb9da0cf4091bc39866e4/water_column_sonar_processing-25.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7cefb57a053699e8d905edca3b9eb351e4b4ca89bfe848c5e185621fbd3ea243",
"md5": "9a5e751b7e19c23987c556821afd6aa2",
"sha256": "4ee2a0d999315cae69dabe6686facb94deb477e3defee57e376cec7877ec91e0"
},
"downloads": -1,
"filename": "water_column_sonar_processing-25.8.0.tar.gz",
"has_sig": false,
"md5_digest": "9a5e751b7e19c23987c556821afd6aa2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 50595,
"upload_time": "2025-08-20T17:18:44",
"upload_time_iso_8601": "2025-08-20T17:18:44.495424Z",
"url": "https://files.pythonhosted.org/packages/7c/ef/b57a053699e8d905edca3b9eb351e4b4ca89bfe848c5e185621fbd3ea243/water_column_sonar_processing-25.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 17:18:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CI-CMG",
"github_project": "water-column-sonar-processing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "water-column-sonar-processing"
}
JSON
