This document describes the HydrOffice Sound Speed Library and Manager (2019.2). For the source code, go here.

2.1. Installation

2.1.1. Installation using the Pydro distribution

Pydro logo

Fig. 2.1 The Pydro logo.

If you are on Windows, you can easily install Sound Speed Manager as part of the NOAA Office of Coast Survey Pydro distribution.

Pydro is a suite of software tools used to support hydrography. It is (almost exclusively) built from open source components as well as public domain custom developed software. Pydro is maintained by Hydrographic Systems and Technology Branch (HSTB) to support NOAA operations (aiding Office of Coast Survey fleet) and is made available for public use.

You can download the latest Pydro installer from here.

2.1.2. Installation as stand-alone Python package

If you decide to install the package in a Python environment, the dependencies are:

If you want to install the last stable version (from PyPI):

  • pip install hyo2.soundspeed

Or, if you prefer the bleeding edge code:

  • pip install https://github.com/hydroffice/hyo2_soundspeed/archive/master.zip

2.1.3. Supplemental Data Space Requirements

Approximately 500 MB of additional disk space is required for the WOA09 db set optionally required (but warmly suggested) by this hydro-package. If not available, the package will attempt to download it.

Alternatively, it is also possible to manually download, unpack the WOA09 data set at any path that SSM can have access to, and modify the configuration file to point to the correct path (see Possible Configurations).

By default, SSM looks for databases at:

  • “C:/Documents and Settings/<username>/Application Data/HydrOffice/Sound Speed/atlases/[woa09 or woa13]” (Windows XP), or

  • “C:/Users/<username>/AppData/Local/HydrOffice/Sound Speed/atlases/[woa09 or woa13]” (newer Windows OS)

Among other improvements, the WOA13 db provides a much better spatial resolution, but this comes with a much larger data size (~18 GB).

Note

If a previous version of the application was installed, Sound Speed Manager will try to localize past installations of WOA databases (WOA09 or WOA13).