sonarcal 0.1.0__tar.gz

sonarcal-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

sonarcal-0.1.0/.github/workflows/build-docs.yml

@@ -0,0 +1,18 @@
+name: Build documentation
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs mkdocstrings[python] mkdocs-material
+      - run: mkdocs gh-deploy --force --clean --verbose
+      

sonarcal-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,145 @@
+name: Build and publish sonarcal
+
+on: push
+
+jobs:
+  # test:
+  #   strategy:  
+  #     matrix:
+  #       os: [ubuntu-latest, windows-latest, macos-latest]
+  #       python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+  #   runs-on: ${{ matrix.os }}
+  #   steps:
+  #     - name: Checkout sonarcal
+  #       uses: actions/checkout@v4
+  #     - name: Set up Python ${{ matrix.python-version }}
+  #       uses: actions/setup-python@v5
+  #       with:
+  #         python-version: ${{ matrix.python-version }}
+  #     - name: Install packages
+  #       run: |
+  #         python -m pip install --upgrade pip
+  #         python -m pip install .[dev]  # NOTE: [dev] includes pytest
+  #     - name: Run tests with pytest
+  #       run: python -m pytest -v -s
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    # needs: test
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Get history and tags for SCM versioning to work
+      run: |
+        git branch
+        git fetch --prune --unshallow
+        git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish sonarcal to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sonarcal
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python distribution with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+
+  publish-to-testpypi:
+    name: Publish sonarcal to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/sonarcal
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        verbose: true
+        repository-url: https://test.pypi.org/legacy/

sonarcal-0.1.0/.gitignore

@@ -0,0 +1,3 @@
+
+/src/sonarcal/__pycache__
+/dist

sonarcal-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Aqulayd LIMITED
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sonarcal-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: sonarcal
+Version: 0.1.0
+Summary: Software to facilitate standard-sphere calibration of omni-directional sonars
+Project-URL: Homepage, https://github.com/Aqualyd-Limited/sonarCal
+Project-URL: Issues, https://github.com/Aqualyd-Limited/sonarCal/issues
+Project-URL: Documentation, https://Aqualyd-Limited/sonarCal
+Project-URL: Repository, https://github.com/Aqualyd-Limited/sonarCal
+Project-URL: Discussions, https://github.com/Aqualyd-Limited/sonarCal/discussions
+Author: Gavin Macaulay
+License: MIT License
+        
+        Copyright (c) 2025 Aqulayd LIMITED
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: acoustic,calibration,sonar
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: h5py
+Requires-Dist: humanize
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pillow
+Requires-Dist: platformdirs
+Requires-Dist: scipy
+Provides-Extra: dev
+Requires-Dist: mkdocs-material; extra == 'dev'
+Requires-Dist: mkdocstrings[python]; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+
+This repository contains a Python packages to assist with the calibration of ship-mounted fisheries omni-sonar systems.
+
+_This package is under active development_
+
+# Installation
+
+Install using pip:
+
+```
+pip install sonarcal
+```
+
+or upgrade:
+
+```
+pip install sonarcal --upgrade
+```
+
+# Documentation
+
+The user and technical manuals are available [here](https://aqualyd-limited.github.io/sonarCal/).

sonarcal-0.1.0/README.md

@@ -0,0 +1,22 @@
+
+This repository contains a Python packages to assist with the calibration of ship-mounted fisheries omni-sonar systems.
+
+_This package is under active development_
+
+# Installation
+
+Install using pip:
+
+```
+pip install sonarcal
+```
+
+or upgrade:
+
+```
+pip install sonarcal --upgrade
+```
+
+# Documentation
+
+The user and technical manuals are available [here](https://aqualyd-limited.github.io/sonarCal/).

sonarcal-0.1.0/docs/index.md

@@ -0,0 +1,24 @@
+# User Manual
+This will be the documentation for the program.
+
+## How to use
+
+![Main screen](assets/screenshot.png){ align=right }
+/// caption
+The main operation screen.
+///
+
+
+![](assets/Beam_example.png){ align=right }
+/// caption
+The seconday display of ping amplitudes.
+///
+
+## Configuration
+
+some text
+
+## Export of data
+
+some text
+

sonarcal-0.1.0/docs/technical.md

@@ -0,0 +1,6 @@
+# Technical Manual
+
+This will be the technical documentation for the program and
+include API documentation if appropriate.
+
+## Adding support for other sonars

sonarcal-0.1.0/mkdocs.yml

@@ -0,0 +1,85 @@
+site_name: sonarcal
+repo_url: https://github.com/Aqualyd-Limited/sonarCal
+edit_uri: edit/main/docs/
+site_url: https://Aqualyd-Limited.github.io/sonarCal
+
+nav:
+    - User Manual: index.md
+    - Technical Manual: technical.md
+
+theme: 
+    name: material 
+    logo: assets/sonarcal_logo.png
+    favicon: assets/sonarcal_logo.png
+    icon:
+        repo: fontawesome/brands/github
+    features:
+        - navigation.top
+        - content.action.view
+        - content.code.copy
+        - search.suggest
+        - search.highlight
+        - search.share
+    palette:
+     # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: amber
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: blue grey
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+
+plugins:
+    - search
+    - autorefs
+    - mkdocstrings:
+        handlers:
+            python:
+                paths: [src]
+                options:
+                    docstring_style: numpy
+                    show_submodules: false
+                    show_symbol_type_heading: true
+                    merge_init_into_class: true
+                    show_bases: true
+                    inherited_members: true
+                    show_root_heading: true
+                    show_root_toc_entry: false
+                    show_source: true
+                    heading_level: 3
+                    filters:
+                        - "!^_"
+
+watch:
+    - ./docs
+
+markdown_extensions:
+    - attr_list
+    - md_in_html
+    - pymdownx.blocks.caption
+    - footnotes
+    - tables
+    - pymdownx.highlight:
+       anchor_linenums: true
+       line_spans: __span
+       pygments_lang_class: true
+    - pymdownx.inlinehilite
+    - pymdownx.snippets
+    - pymdownx.superfences
+    - admonition
+    - pymdownx.details
+  

sonarcal-0.1.0/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["hatchling", 'hatch-vcs']
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sonarcal"]
+
+[project]
+name = 'sonarcal'
+license = {file = "LICENSE"}
+keywords = ["acoustic", "sonar", "calibration"]
+authors = [
+  { name="Gavin Macaulay"}
+]
+description = 'Software to facilitate standard-sphere calibration of omni-directional sonars'
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+	"numpy",
+	"scipy",
+  "matplotlib",
+  "pandas",
+  "humanize",
+  "h5py",
+  "Pillow",
+  "platformdirs"
+]
+classifiers = [
+    'Development Status :: 3 - Alpha',
+    'Intended Audience :: Science/Research',
+    'License :: OSI Approved :: MIT License',
+    'Operating System :: OS Independent',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
+    'Programming Language :: Python :: 3.14',
+    'Topic :: Scientific/Engineering',
+]
+dynamic = [ 'version']
+
+[project.scripts]
+sonarcal = "sonarcal.controller:main"
+
+[tool.hatch.version]
+source = 'vcs'
+
+[tool.hatch.version.raw-options]
+local_scheme = "no-local-version"  # otherwise the non-tagged version is not accepted by testpypi
+
+[tool.pytest.ini_options]
+testpaths = ['tests',]
+addopts = ["--import-mode=importlib",]
+
+[project.optional-dependencies]
+dev = [
+  "mkdocstrings[python]",
+  "mkdocs-material",
+  "twine",
+  "pytest",
+]
+
+
+[project.urls]
+Homepage = 'https://github.com/Aqualyd-Limited/sonarCal'
+Issues = 'https://github.com/Aqualyd-Limited/sonarCal/issues'
+Documentation = 'https://Aqualyd-Limited/sonarCal'
+Repository = 'https://github.com/Aqualyd-Limited/sonarCal'
+Discussions = 'https://github.com/Aqualyd-Limited/sonarCal/discussions'

sonarcal-0.1.0/src/sonarcal/__main__.py

@@ -0,0 +1,4 @@
+"""Provides a command line interface to the calibration program."""
+from sonarcal import controller
+
+controller.main()

sonarcal-0.1.0/src/sonarcal/calculate_gains.py

@@ -0,0 +1,7 @@
+import pandas as pd
+
+def calculate_gain(sphere_ts):
+    """Calculate the beam calibration gain and other stats."""
+    df = pd.DataFrame(sphere_ts, columns=['timestamp', 'ts', 'range'])
+    return (df['ts'].mean(), df['ts'].std(), df['range'].mean(), len(df))
+

sonarcal-0.1.0/src/sonarcal/calibration_data.py

@@ -0,0 +1,19 @@
+import pandas as pd
+
+class calibrationData():
+    """Storage for sonar caliration results."""
+
+    def __init__(self):
+        self.data = pd.DataFrame(columns=['Time', 'Gain (dB)', 'RMS (dB)', 'Range (m)', 'Echoes'])
+        self.data.index.name = 'Beam'
+    
+    def update(self, beam: int, timestamp: str, gain: float, rms: float, r: float, num: int):
+        self.data.loc[beam] = (timestamp, gain, rms, r, num)
+        
+    def remove(self, beams: list[int]):
+        """Remove data for given beam."""
+        self.data.drop(index=beams, inplace=True)
+        
+    def df(self):
+        return self.data  # eventually return a better form of the data?
+