Installation

The CTD-Client is distributed as windows executable (.exe). You can find the latest version here. You do not need anything else and can put the .exe file anywhere you want to, but it is recommended to use a default path, like C:/Programs. To update the software, just replace the exe with a more recent one. You can get notified about new versions by subscribing to this rss feed: https://git.io-warnemuende.de/CTD-Software/CTD-Client/releases.rss

Configuration

The settings of the CTD-Client are stored inside C:/user/USERNAME/AppData/Local/ctdclient/ctdclient . All configuration can be done via the GUI of the software. If you still want to check on the individual config files, you will find them via the path above. The possible configuration files found here are:

  • the main config file, ctdclient.toml

  • the processing config files, prefixed with “proc_”

  • the nrt config files, prefixed with “nrt_”

How to configure

The main configuration file looks like this:

ctdclient.toml
# base configuration for the software internals and system specifics which are
# usually set only once during the software installation process.
# Most of these settings can be set via the CTD-Clients GUI
last_platform = "CTD"
[base]
# lets you configure different platforms/devices. Unused at the moment.
platforms = ["CTD", "Scanfish"]
# the path to the seasave executable
seasave_exe = "C:\\Program Files (x86)\\Sea-Bird\\SeasaveV7\\Seasave.exe"
# the path to the seasave processing modules
processing_exes = "C:\\Program Files (x86)\\Sea-Bird\\SeasaveV7\\SBEDataProcessing-Win32"
# whether to display the option, to close bottles automatically during downcast.
# Will be always true otherwise.
downcast_option = false
# save the processing workflow file used for processing inside the given directory. 
# If none given, no fingerprint will be saved.
generate_processing_fingerprint = ""
# save all files used/created during the processing workflow in individual directories inside the given directory. 
# If none given, no files will be saved (additionally to the usual file saving done).
file_type_dir = ""
# toggles debugging mode, that displays more (debugging) information
debugging = false
# lets the user define a scaling factor of the GUI
scaling = 1.1
# sets a minimum pressure difference that individual bottles will be separated to, when put to the same depth value. 
# Prevents slow hardware from not closing both bottles in time.
# Can be set to 0 if unwanted.
minimum_bottle_difference = 0.0

[dship]
# whether to use values from dship or random ones (for testing/debugging)
use_dship_values = true
# absolute base path to dship
ip = "dship1"
# the dship url to the 'API'
url_part = ":8080/dship-web/service/samples"
# timeout between individual API calls in seconds
fetch_intervall = 1

[dship.identifier]
# the internal dship variables names of the different parameters
Cruise = "SYS.DISP.ExpNumber"
Station = "ActionLog.PUP.DopName"
GPS_Time = "SYS.DISP.TimeTxt"
GPS_Lat = "SYS.STR.PosLat"
GPS_Lon = "SYS.STR.PosLon"
Water_Depth = "SYS.CALC.WaterDepth"
Air_Pressure = "Weatherstation.PEUMA.Air_pressure"
Position_Alias = "Web.PUP.NextWPName"
Device = "ActionLog.PUP.DeviceShortName"

[email]
# define settings of a local email server
smtp_server = "192.168.236.240"
smtp_port = 25
smtp_email = "ctd@borgese.briese-research.de"

[operators]
# the names of the different CTD operators of this cruise. These will be available for selection in the dropdown on the main page.
op1 = ""
op2 = ""
op3 = ""
op4 = ""
op5 = ""
last = ""

[near_real_time]

[plotting]
# all settings for plotting configuration
auto_plot = false
plot_dir = ""
embed_contents = false
overwrite = true
size_limit = "10"
filter = ""
show_html = true
html_title = ""

[ctd]

[ctd.paths]
# the configuration file of the Seasave software
seasave_psa = "."
# the path were the raw data files will be stored at
output_directory = "."
# the instruments configuration file
xmlcon = "."
# the number of water bottles currently installed on the CTD rosette
number_of_bottles = 13

[ctd.memory]
last_cast = 0
last_filename = "."
last_processing_file = "templates/processing_template.toml"

In general, this section is divided into two parts: the ‘basic’ configuration tab, that allows to edit settings concerning the measurement, for example to set paths to the Seasave.psa or the XMLCON. And the ‘expert’ part, that allows the setting of low-level options, like the update server or the activation of debug mode.

Basic settings

Lets you define the basic file paths the software needs in order to interact with Sea-Birds measurement software, ‘Seasave’.

seasave psa: the configuration file of the Seasave software

output directory: the path were the raw data files will be stored at

xmlcon: the instruments configuration file

number of bottles: the number of water bottles currently installed on the CTD rosette

operators: the names of the different CTD operators of this cruise. These will be available for selection in the dropdown on the main page.

Expert settings

Warning

This configuration should only be made by people who have a good knowledge of the Seasave software stack and the different file types that Sea-Bird is using.

base

seasave exe: the path to the seasave executable

processing exes: the path to the seasave processing modules

downcast option: whether to display the option, to close bottles automatically during downcast. Will be always true otherwise.

generate processing fingerprint: save the processing workflow file used for processing inside the given directory. If none given, no fingerprint will be saved.

file type dir: save all files used/created during the processing workflow in individual directories inside the given directory. If none given, no files will be saved (additionally to the usual file saving done).

debugging: toggles debugging mode, that displays more (debugging) information

scaling: lets the user define a scaling factor of the GUI

minimum bottle difference: sets a minimum pressure difference that individual bottles will be separated to, when put to the same depth value. Prevents slow hardware from not closing both bottles in time. Can be set to 0 if unwanted.

dship parameters

Here, you can define the different DSHIP variables to use for polling values from.

email config

Lets you set the settings of a local email server, that can be used for sending emails inside the CTD-Client. Near-Real-Time data distribution, debugging info sending and general email requests can be used via a local email server.