Skip to content

Commit

Permalink
added note about restarting after listeners changes
Browse files Browse the repository at this point in the history
  • Loading branch information
giumas committed Jul 12, 2018
1 parent 7d22089 commit 9b6c579
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
# The short X.Y version.
version = '2018.1'
# The full version, including alpha/beta/rc tags.
release = '2018.1.29'
release = '2018.1.41'

numfig = True

Expand Down
15 changes: 10 additions & 5 deletions docs/user_manual_installation_2_configurations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,7 @@ Method #1
---------

This method is usually used for the case where the hydro-package and *SIS* are installed on the same machine.
However, since the *User Defined UDP* port cannot be modified, this method may not be suitable if this mechanism is
already in used by another program.
However, this method may not be suitable if this mechanism is already in used by another program.
In such a case, the *DataDistrib.exe* program explored in :ref:`method_3` may be attempted.

The configuration for this method is actually quite simple:
Expand All @@ -153,6 +152,9 @@ The configuration for this method is actually quite simple:
* Click the *OK* button at the top left of the tabbed panels.
* Restart pinging.

.. note:: The value of the *User Defined UDP* port in *SIS* cannot be modified.


.. _method_2:

Method #2
Expand All @@ -161,9 +163,6 @@ Method #2
This method is more general, and it can be used for data transmission to other computers on the network
(by specifying IP address and port, as well as transmission rate).

.. note:: *SIS* needs to be restarted for the changes to take effect. Furthermore, since the software does not seem
to validate user inputs, mistakes made cannot be easily discovered and undone (unsubscribe).

* From the *Tools* menu, choose *Custom…* and then *Datagram Distribution* (see :numref:`method_2_fig`).

.. _method_2_fig:
Expand All @@ -182,6 +181,10 @@ This method is more general, and it can be used for data transmission to other c
* Click the *Subscribe* button.
* Repeat Steps 2-4 for the *SVP (U)* and the *XYZ88 (X)* datagrams.

.. note:: *SIS* needs to be restarted for the changes to take effect. Furthermore, since the software does not seem
to validate user inputs, mistakes made cannot be easily discovered and undone (unsubscribe).


.. _method_3:

Method #3
Expand Down Expand Up @@ -287,6 +290,8 @@ This should match the port address selected in the previous methods. For instanc

The *Client list*, in red, is used to add the *SIS* client information.

.. warning:: To apply changes to the listeners settings, restart *Sound Speed Manager*.

If both *SIS* and *Sound Speed Manager* sides have been properly configured, *Sound Speed Manager* will show (in the right side
of the lower window statusbar, see :numref:`settings5`) the date, geographic position, surface sound speed and average depth (when *SIS* is pinging).

Expand Down
2 changes: 1 addition & 1 deletion hyo/soundspeed/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
log = logging.getLogger(__name__)
log.addHandler(logging.NullHandler())

__version__ = '2018.1.40'
__version__ = '2018.1.41'
__doc__ = "Sound Speed"
__author__ = '[email protected]; [email protected]; [email protected]; ' \
'[email protected]'
Expand Down
2 changes: 1 addition & 1 deletion hyo/soundspeedmanager/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
logger = logging.getLogger(__name__)
logger.addHandler(logging.NullHandler())

__version__ = '2018.1.40'
__version__ = '2018.1.41'
__doc__ = "Sound Speed Manager"
__author__ = '[email protected]; [email protected]; [email protected]; ' \
'[email protected]'
Expand Down
Binary file modified hyo/soundspeedmanager/pdf/SoundSpeedManager.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion hyo/soundspeedsettings/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
logger = logging.getLogger(__name__)
logger.addHandler(logging.NullHandler())

__version__ = '2018.1.40'
__version__ = '2018.1.41'
__doc__ = "Sound Speed Settings"
__author__ = '[email protected]; [email protected]; [email protected]; ' \
'[email protected]'
Expand Down
16 changes: 13 additions & 3 deletions hyo/soundspeedsettings/widgets/listeners.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def __init__(self, main_win, db):
hbox = QtGui.QHBoxLayout()
self.left_layout.addLayout(hbox)
hbox.addStretch()
self.label = QtGui.QLabel("SIS:")
self.label = QtGui.QLabel("SIS(*):")
hbox.addWidget(self.label)
hbox.addStretch()

Expand Down Expand Up @@ -101,7 +101,7 @@ def __init__(self, main_win, db):
hbox = QtGui.QHBoxLayout()
self.left_layout.addLayout(hbox)
hbox.addStretch()
self.label = QtGui.QLabel("Sippican:")
self.label = QtGui.QLabel("Sippican(*):")
hbox.addWidget(self.label)
hbox.addStretch()

Expand Down Expand Up @@ -139,7 +139,7 @@ def __init__(self, main_win, db):
hbox = QtGui.QHBoxLayout()
self.right_layout.addLayout(hbox)
hbox.addStretch()
self.label = QtGui.QLabel("MVP:")
self.label = QtGui.QLabel("MVP(*):")
hbox.addWidget(self.label)
hbox.addStretch()

Expand Down Expand Up @@ -392,6 +392,16 @@ def __init__(self, main_win, db):

self.right_layout.addStretch()

# - active setup
hbox = QtGui.QHBoxLayout()
self.main_layout.addLayout(hbox)
hbox.addStretch()
label = QtGui.QLabel("<i>* To apply changes to the listeners, restart the application.</i>")
label.setFixedHeight(22)
label.setStyleSheet("QLabel { color : #aaaaaa; }")
hbox.addWidget(label)
hbox.addStretch()

self.main_layout.addStretch()

self.setup_changed() # to trigger the first data population
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def txt_read(*paths):
setup_args = dict()

setup_args['name'] = 'hyo.soundspeed'
setup_args['version'] = '2018.1.39'
setup_args['version'] = '2018.1.41'
setup_args['url'] = 'https://bitbucket.org/ccomjhc/hyo_soundspeed/'
setup_args['license'] = 'LGPLv2.1 or CCOM-UNH Industrial Associate license'
setup_args['author'] = 'Giuseppe Masetti(UNH,CCOM); Barry Gallagher(NOAA,OCS); ' \
Expand Down

0 comments on commit 9b6c579

Please sign in to comment.