improved SSM manual

AUTHORS.rst

@@ -4,7 +4,7 @@ Credits
 Authors
 ~~~~~~~
 
-HydrOffice Sound Speed is developed and maintained by:
+The package developers and maintainers are:
 
 - `Giuseppe Masetti <mailto:[email protected]>`_
 
@@ -16,7 +16,9 @@ HydrOffice Sound Speed is developed and maintained by:
 Contributors
 ~~~~~~~~~~~~
 
-The following wonderful people contributed directly or indirectly to this project:
+Other past and present contributors are:
+
+- `Hugh Barker <mailto:[email protected]>`_
 
 - `Jonathan Beaudoin <mailto:[email protected]>`_
 
@@ -30,9 +32,11 @@ The following wonderful people contributed directly or indirectly to this projec
 
 - `Paul Johnson <mailto:[email protected]>`_
 
-- `Damian Manda <[email protected]>`_
+- `Damian Manda <mailto:[email protected]>`_
+
+- `Jean-Guy Nistad <mailto:[email protected]>`_
 
-- `Jean-Guy Nistad <[email protected]>`_ 
+- `Collen Peters <mailto:[email protected]>`_
 
 - `Patrice Ponchant <mailto:[email protected]>`_
 

README.rst

@@ -46,26 +46,38 @@ General Info
 .. image:: https://www.hydroffice.org/static/app_soundspeed/img/logo.png
  :alt: logo ssm
 
-HydrOffice is a research development environment for ocean mapping. Its aim is to provide a collection of
-hydro-packages to deal with specific issues in such a field, speeding up both algorithms testing and
-research-2-operation.
+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).
 
-This package provides functionalities to manage sound speed profiles.
+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.
 
-The package is jointly developed by NOAA OCS and UNH JHC/CCOM.
+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.
 
-.. image:: https://www.hydroffice.org/static/app_soundspeed/img/noaa_ccom.png
- :alt: joint efforts
+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.
 
-Key Features:
+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.
 
-* Accommodates commonly-used sound speed profile formats
-* Ensures compatibility with various data sources
-* Integrates with common data acquisition and integration applications (like Kongsberg SIS)
-* Includes real-time and climatological models to improve the accuracy of your data
-* Collects and manages data efficiency through built-in database functionalities
-* Offers tools for analysis and visualization
+The package is jointly developed by the `Center for Coastal and Ocean Mapping, UNH<https://ccom.unh.edu/>`_ and
+`NOAA Coast Survey Development Laboratory (CSDL) <https://www.nauticalcharts.noaa.gov/>`_.
 
+.. image:: https://www.hydroffice.org/static/app_soundspeed/img/noaa_ccom.png
+ :alt: joint efforts
 
 For further information, visit the `manual <https://www.hydroffice.org/manuals/ssm2/index.html>`_.

docs/conf.py

@@ -57,7 +57,7 @@
 # The short X.Y version.
 version = '2024.0'
 # The full version, including alpha/beta/rc tags.
-release = '2024.0.0'
+release = '2024.0.2'
 
 numfig = True
 

docs/credits.rst

@@ -4,19 +4,19 @@
 Credits
 *******
 
-Sound Speed library and manager are based on an ongoing joint development between the NOAA's `Office of Coastal Survey
-<http:https://www.nauticalcharts.noaa.gov/>`_ and UNH's `Center for Coastal and Ocean Mapping <http:https://ccom.unh.edu>`_.
+Sound Speed library and manager are jointly developed by the `Center for Coastal and Ocean Mapping, UNH<https://ccom.unh.edu/>`_ and
+`NOAA Coast Survey Development Laboratory (CSDL) <https:https://www.nauticalcharts.noaa.gov/>`_.
 
 
-HydrOffice Sound Speed is developed and maintained by:
+The package developers and maintainers are:
 
 - `Giuseppe Masetti <mailto:[email protected]>`_
 
 - `Barry Gallagher <mailto:[email protected]>`_
 
 - `Chen Zhang <mailto:[email protected]>`_
 
-Other contributors:
+Other past and present contributors are:
 
 - `Hugh Barker <mailto:[email protected]>`_
 
@@ -36,6 +36,8 @@ Other contributors:
 
 - `Jean-Guy Nistad <mailto:[email protected]>`_
 
+- `Collen Peters <mailto:[email protected]>`_
+
 - `Patrice Ponchant <mailto:[email protected]>`_
 
 - `Glen Rice <mailto:[email protected]>`_

docs/in_brief.rst

@@ -6,30 +6,42 @@ In Brief
 .. image:: https://github.com/hydroffice/hyo2_soundspeed/raw/master/hyo2/ssm2/app/gui/soundspeedmanager/media/app_icon.png
  :alt: logo
 
-The Sound Speed package is part of the `HydrOffice <https://www.hydroffice.org/license/>`_ framework. HydrOffice is
-a research development environment for ocean mapping. It provides a collection of hydro-packages, each of them dealing
-with a specific issue of the field. The main goal is to speed up both algorithms testing and research-to-operation (R2O).
+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.
 
-The Sound Speed package provides both a library and an application with functionalities to manage sound speed profiles,
-and to provide pre-processing ocean mapping tools to help bridge the gap between sound speed profiling instrumentation
-and multibeam echosounder acquisition systems.
+SSM has merged together functionalities present in several applications that process sound speed profiles (SSP):
 
-It has been developing with the aim to merge together functionalities present in several applications that process sound
-speed profiles (SSP) for underwater acoustic systems:
+* *Velocipy*, an application originally developed at the `NOAA Coast Survey Development Laboratory (CSDL) <https://www.nauticalcharts.noaa.gov/>`_
+ as part of the `Pydro environment<https://svn.pydro.noaa.gov/Docs/html/Pydro/universe_overview.html>`_.
 
-* *Velocipy*, an application originally developed at the `NOAA Coast Survey Development Laboratory (CSDL) <http:https://www.nauticalcharts.noaa.gov/>`_
- as part of the Pydro environment.
-
-* *SVP Editor*, an application originally developed at the `Center for Coastal and Ocean Mapping (CCOM, UNH) <http:https://ccom.unh.edu/>`_
+* *SVP Editor*, an application originally developed at the `Center for Coastal and Ocean Mapping, UNH<https://ccom.unh.edu/>`_
  for the MAC project (`Multibeam Advisory Committee <http:https://mac.unols.org/>`_)
  under the NSF grant 1150574.
 
-* *SSP Manager*, an application developed at the `Center for Coastal and Ocean Mapping (CCOM, UNH) <http:https://ccom.unh.edu/>`_
+* *SSP Manager*, an application developed at the `Center for Coastal and Ocean Mapping, UNH<https:https://ccom.unh.edu/>`_
  as part of the HydrOffice framework under NOAA grants NA10NOS4000073 and NA15NOS4000200.
 
-In the integration of all these implementations to the current package several improvements have been
-introduced to enhance code maintainability (e.g., Python 3 support) and to store the collected data for further
-processing and analysis.
+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<https://ccom.unh.edu/>`_ and
+`NOAA Coast Survey Development Laboratory (CSDL) <https://www.nauticalcharts.noaa.gov/>`_.
 
 The current development of Sound Speed Manager is partially supported by:
 

docs/user_manual_setup_sis_v5.rst

@@ -6,7 +6,10 @@ Sound Speed Manager - SIS v5 interaction
 .. index:: SIS; v5
 .. index:: K-Controller
 
-SIS v5 is currently supported through the Data Distribution application (usually installed with SIS v5).
+SIS v5 is currently supported in two ways:
+
+* Through the Data Distribution application (usually installed with SIS v5).
+* Using the dedicated *Sound Speed Manager (SSM) IP and port* field (**only for SIS v5.14+**).
 
 This method covers both cases:
 
@@ -16,8 +19,8 @@ This method covers both cases:
 
 .. _ssm_sis5_sis_settings:
 
-SIS v5 settings
----------------
+SIS v5 settings (through Data Distribution)
+-------------------------------------------
 
 Verify Data Distribution settings in SIS v5:
 
@@ -58,13 +61,36 @@ settings (see :numref:`data_dist_exe_fig`):
  Data Distribution requires to have SIS v5 in execution.
  Setups with the K-Controller interacting with acquisition software different from SIS v5 are *currently* unsupported.
 
+.. _ssm_sis5_sis_settings_2:
+
+SIS v5 settings (using *Sound Speed Manager (SSM) IP and port* field)
+---------------------------------------------------------------------
+
+This solution is available only in SIS 5.14 (and higher):
+
+* In the SIS *Tools* menu, open the *Parameter Setup*.
+* Navigate to the *sound speed* menu.
+* In the *Sound Speed Manager (SSM) IP and port* field (see :numref:`sis_sound_speed_menu_fig`), enter the IP address of the SSM workstation and the port number (e.g., 16103). If SIS and SSM are on the same computer, use: 127.0.0.1:16103
+* Restart SIS.
+
+.. _sis_sound_speed_menu_fig:
+
+.. figure:: ./_static/sis_sound_speed_menu.png
+ :width: 640px
+ :align: center
+ :alt: figure with SIS Sound Speed menu
+ :figclass: align-center
+
+ SSM datagram configuration in SIS.
+
 .. _ssm_sis5_ssm_settings:
 
 SSM settings
 ------------
 
 Open in editing mode the Sound Speed Manager’s Setup Tab, then set the SIS listen port (that you have set in
-the Data Distribution Configuration) in the Listeners sub-tab (see :numref:`ssm_sis5_p1_fig`).
+the Data Distribution Configuration or in the *Sound Speed Manager (SSM) IP and port* field) in the Listeners
+sub-tab (see :numref:`ssm_sis5_p1_fig`).
 
 .. _ssm_sis5_p1_fig: