From 3f2e4239b012601e6c3fa75a7d06912f0f69ecfb Mon Sep 17 00:00:00 2001 From: Marie Date: Thu, 18 Jan 2024 19:37:17 -0800 Subject: [PATCH] added help details server connection & calibration --- .../tethys/docs/tethys_quickstart.html | 236 ++++++++++++++++-- 1 file changed, 220 insertions(+), 16 deletions(-) diff --git a/src/help/utilities/tethys/docs/tethys_quickstart.html b/src/help/utilities/tethys/docs/tethys_quickstart.html index d492f5a6..fd7543e7 100644 --- a/src/help/utilities/tethys/docs/tethys_quickstart.html +++ b/src/help/utilities/tethys/docs/tethys_quickstart.html @@ -25,28 +25,232 @@ export to Tethys.

+

Connection and Project Details

-

Tethys Server

-

Make sure you have a Tethys Server running. The PAMGuard interface will - only work with Tethys 3.

-

Check the server connection. If PAMGuard has correctly connected to the Tethys server, the top panel of the display will be a normal - grey colour. If the connection cannot be made, the panel will be orange.

-

If required, change the server settings using the "Select Sever" button

+

+ Make sure you have a Tethys Server running. The PAMGuard interface will + only work with Tethys + 3 or later. The section below specifies how to set the + address of Tethys server address as well as determine if + PAMGuard can communicate successfully with Tethys. (The top + panel will be orange if communication is not working. +

+

Tethys Server

+ + +

+ The Tethys Server field next to the picture of the goddess Tethys + indicates the address of the Tehtys server. To change this field, + click on the gear icon. You will be prompted to provide a computer + address (URL) and a port. The address should start with http:// + followed by the machine name or internet protocol address unless + the Tethys server has been configured to use an encrypted + connection. In this case, start the address with https://. +

+ +

+ By default, PAMGuard will use http://localhost:9779 which + assumes that your Tethys server is running on the same computer as + PAMGuard and that it expects communication on port 9779, the + default port (administrators may change this). +

+ +

+ If PAMGuard can communicate with the Tethys server, the + Connection and Project panel will be light grey. If + communication is not possible, the panel will be colored + orange. Likely causes for communication failure are: +

+

Project and Instrument Information

-

Either select an existing "Project", or create a new one.

-

You also need to give Tethys more information about the instrument(s) or arrays you've deployed than in previous PAMGuard versions. Again, select an - existing instrument, or set up a new one. You'll notice that this information is held with the rest of the PAMGuard array management information.

+ +

+ Projects are names used by Tethys to help track work that should + be considered together, such as a series of deployments designed + to answer a specific question or funded under a specific + grant. If you do not already have a project defined in your + PAMGuard database, you can click the "New Project" button in the + "Connection and Project details" section of the Tethys + module. This will start a dialog that asks for a case-sensitive + project name and a geographic region. The geographic region is + for convenience, PAMGuard and Tethys track information by + longitude and latitude, but sometimes it is helpful to query for + information with respect to a geographic name such as Channel + Islands National Marine Sanctuary. +

+ +

+ The array instrumentation is selected from a drop-down menu next + to the Instruments label. A dropdown menu next to the label + “Instruments” shows the list of hydrophone arrays. These are + likely to have been previously established prior to starting + analysis of your data by using the menu Settings -> Hydrophone + Array. + +

+ +

+ If you are a long-time user of PAMGuard, you will notice + additional fields are required for instrumentation: Instrument + Type and Instrument Id. The type indicates what type of + instrument is being used and may be generic such as a mooring or + array or denote a specific instrument such as a HARP, Rock + Hopper, SoundTrap, etc. The Id is a unique identifier for the + instrument such as a serial number. Note that if you are using + an older PAMGuard database, you may see a blank entry in the + instruments list as these new fields will not have been + populated. Press new/edit to access the instrument settings + from the Tethys module page. +

Data Export

-

It's best to export data in the sequence the panels are laid out in on the PAMGuard display, i.e. Calibrations, then Deployments, and finally Detections.

-

Calibrations

-

To export the calibration data, press the "Export..." button at the top of the "Instrument Calibration Information" panel. -

Most of the calibration data is taken from the array manager and from the sound acquisition module. However, PAMGuard will ask a few questions about - HOW the instrument was calibrated, when it was done and who is responsible. Fill in as much information as you can! - IF the export is successful, a record will show for each hydrophone (or sensor) in your instrument array in the calibration information table:

+

+ It is best to export data in the sequence the panels are laid out in on the PAMGuard display: +

+ +
    +
  1. + Instrument calibration information: exports to the Tethys Calibrations +
    2. + +
  2. + Recording periods and deployment information: exports to Tethys Deployments +
    3. + +
  3. + PAMGuard data blocks: exports to Tethys Detections and/or Localizations. +
    4. +
+ + +

Instrument calibration information

+ +

+ Most of the calibration data is taken from the array manager and + from the sound acquisition module. However, PAMGuard will ask a + few questions about HOW the instrument was calibrated, when it + was done and who is responsible. +

+

+ There are two dialogs associated with calibration. The first + asks for a calibration method and has the following fields: +

+ + +

+ The second calibrations dialog asks for: +

+ + + +

+ Fill in as much information as you can! + If the export is successful, a record will show for each + hydrophone (or sensor) in your instrument array in the + calibration information table: +

@@ -55,7 +259,7 @@ PAMGuard database and binary Store. Where data were collected on a regular duty cycle, or continuously, there should be a single record in the table of recording periods. If data were collected on a more - "ad-hoc" basis, for instance during a boat based survey, there might be many different records in the table. + "ad-hoc" basis, for instance during a boat-based survey, there might be many different records in the table. Occasionally, there may be short recording periods (e.g. while you were testing kit on deck) that you don't want to export. Either select individual rows that you want to export, or right click on the table and "Select All".