PAMGuard is compatible with Tethys 3.0, released early in 2024.
-The Tethys database is not a replacement for the existing - +
PAMGuard is compatible with Tethys 3.0 or above, released early in 2024.
+The Tethys database is not a replacement for the existing
PAMGuard Database.
Where the PAMGuard database only contains data from a single instrument or cruise, the Tethys
database contains data from many cruises and projects and can be used to hold a summary of all data
@@ -60,8 +59,7 @@ img {
- Next: Configuring the Tethys
- Module
+ Next: Quick Start
This 'Quick Start' guide is aimed at people who are already familiar with both Tethys and PAMGuard
+The Tethys database is only used in + PAMGUard Viewer mode and is only used to archive project data to a single + centralised database. + It is NOT a replacement for the existing PAMGuard database.
+ +Launch PAMGuard in Viewer Mode with an existing set of data.
+Add a Tethys module to PAMGuard from the File / Add Modules / Utilities menu.
+A new tab panel will show the Tethys interface
+The tab shows a number of panels for the connection to the server and the various types + of data that will be output to the database. Some of these should summary information on what's in the + current PAMGuard dataset (consisting of your PAMGuard database and binary store), others may be empty until you start to + export to Tethys.
+ + + +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
+ + +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.
+ +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.
+ +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:
+ +
PAMGuard will have done it's best to work out the temporal extent of your data by looking in the + 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. + 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".
+ +Press the "Export..." button and work through the questions to provide additional information about your data, why it was collected, etc.
+Once the document(s) have been exported, the document names will be shown alongside each PAMGuard deployment period
+
The bottom left panel shows a list of different types of PAMGuard data that can be exported and should also show the total numbers of each type of data that are available + within the PAMGuard storage systems. Select the datablock you want to export from and press "Export...".
+You really don't want to try to export zillions of data to Tethys , in the options that will appear you can opt to just export certain types of detections + or summary counts.
+ +Next: Configuring the Tethys Module
+