Skip to main content

HydrOffice Sound Speed Manager

logo

PyPi version Latest Documentation Windows Linux codacy coverall Zenodo DOI


General Info

The HydrOffice’s Sound Speed package provides a library and tools to manage sound speed profiles. The package is part of HydrOffice, a research development framework for ocean mapping. HydrOffice aims to provide a collection of hydro-packages to deal with specific issues in the field, speeding up both algorithms testing and research-to-operation (R2O).

Among the tools developed in the package, Sound Speed Manager (SSM) is a software application that provides the user with a streamlined workflow to perform accurate processing and management of sound speed profiles for underwater acoustic systems.

SSM has been designed to ease integration into existing data acquisition workflows. The liberal open source license used by the project (specifically, GNU LGPL) provides for understanding of the chosen processing solutions through ready inspection of the source code, as well as the ability to adapt the application to specific organization needs.

This adaptation is eased by the modular design of the application, with the NOAA-specific functionalities organized so that they can be easily deactivated for non-NOAA users.

The main functionalities include:

  • Wide support of commonly-used sound speed profile formats

  • Compatibility with various data sources

  • Integration with common data acquisition/integration applications (e.g., Kongsberg SIS)

  • Profile enhancement based on real-time and climatologic models

  • Database management of the collected data with built-in functionalities for analysis and visualization.

With a long-term support and development plan, Sound Speed Manager is a turnkey application ready to be used (and extended) by professionals and institutions in the hydrographic community.

The package is jointly developed by the Center for Coastal and Ocean Mapping, UNH and NOAA Coast Survey Development Laboratory (CSDL).

joint efforts

For further information, visit the manual.


History

2024.0.0

2024-01-26

  • Started migration from PySide2 to PySide6

2020.0.0

2020-04-09

  • Started migration from Basemap to Cartopy

2019.0.0

2018-11-30

  • Started migration to PySide2 and hyo.abc

2018.0.5

2018-01-10

  • Added automated processing setup and other improvements

2017.3.0

2017-07-31

  • Added Survey Data monitor

2017.0.0

2017-03-18

  • First stable release.

2016-03-27

  • Initial commit.


Credits

Authors

The package developers and maintainers are:

Contributors

Other past and present contributors are:

Please add yourself here when you submit your first pull request.


How to contribute

Every open source project lives from the generous help by contributors that sacrifice their time and this is no different.

Public Repositories

The source code is available on GitHub.

To propose changes to Sound Speed Manager, you can follow the common Fork & Pull Request workflow. If you are not familiar with such a workflow, a good starting point may be this short tutorial.

Coding Style

To make participation as pleasant as possible, this project adheres to the Code of Conduct by the Python Software Foundation.

Here are a few hints and rules to get you started:

  • Add yourself to the AUTHORS.txt file in an alphabetical fashion. Every contribution is valuable and shall be credited.

  • If your change is noteworthy, add an entry to the changelog.

  • No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!

  • Don’t ever break backward compatibility.

  • Always add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won’t be merged. If a feature is not tested or documented, it does not exist.

  • Obey PEP 8 and PEP 257.

  • Write good commit messages.

  • Ideally, collapse your commits, i.e. make your pull requests just one commit.

Thank you for considering to contribute! If you have any question or concerns, feel free to reach out to us.

Development Quick-start

Clone and install (in development mode) the GitHub repo:

  • git clone https://github.com/hydroffice/hyo2_soundspeed.git

  • pip install -e hyo2_soundspeed

The previous steps will also install all the required dependencies.

If you have issues installing hyo2.abc2, you may want to:

  • git clone https://github.com/hydroffice/hyo2_abc2.git

  • pip install -e hyo2_abc2

For other issues installing dependencies (e.g., GDAL), you may want to use Anaconda.

Good references for a working dev env are:

Metadata

Release files for hyo2.ssm2 2024.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hyo2.ssm2 2024.2.1
File Size Uploaded
hyo2_ssm2-2024.2.1.tar.gz 27.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for hyo2.ssm2 2024.2.1
File Interpreter ABI Platform
hyo2.ssm2-2024.2.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 27.5 MB

Release files / hyo2_ssm2-2024.2.1.tar.gz

Download URL hyo2_ssm2-2024.2.1.tar.gz
Size 27.1 MB
Tags Source
SHA-256 checksum
How to use checksums
77d1d0599b653e7b172c5238059f432bf983d011946a44352130f30fea75cea9
BLAKE2b-256 checksum
How to use checksums
4f65f16a79e2c1df330829017e261372b9d815bb3dd56e5cd6bdd3a7c05b4cec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.8

Release files / hyo2.ssm2-2024.2.1-py2.py3-none-any.whl

Download URL hyo2.ssm2-2024.2.1-py2.py3-none-any.whl
Size 384.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b353b5d86016bb9dec08326743baa4f1884c69ae2f09da449f3ae43c5f73559d
BLAKE2b-256 checksum
How to use checksums
cb67f164ac73746c0d19080d7f6e4f1edaede0d325cc81d5ae599ab9ff306fb3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.8

Release history Release notifications | RSS feed

This release

2024.2.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page