-
-
-
Tethys is a freely diff --git a/src/help/utilities/tethys/docs/tethys_quickstart.html b/src/help/utilities/tethys/docs/tethys_quickstart.html index fd7543e7..ed6fb72b 100644 --- a/src/help/utilities/tethys/docs/tethys_quickstart.html +++ b/src/help/utilities/tethys/docs/tethys_quickstart.html @@ -255,21 +255,151 @@
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
-
+ Tethys uses deployment records to register information about + when instruments have been deployed as well as their + characteristics. Examples of characteristics that are recorded + include sample rate and the number of quantization bits, + description of duty cycles (if applicable), hydrophone geometry, + and enough details to be able find calibration data for specific + hydrophones. +
+ ++ PAMGuard will examine the + PAMGuard + database + and + binary Store to determine what records should be generated for + your instrumentation. +
-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...".
++ Where data were collected continuously or on a regular duty + cycle, PAMGuard will create a single deployment record. If data + were collected on a more "ad-hoc" basis, where the instrument has + been deployed multiple times or has irregular recording, PAMGuard + will generate a deployment record for each period of recording. +
+ ++ The figure below shows an example of ad-hoc recording periods + identified by PAMGuard: +
++ Occasionally, there may be short recording periods (e.g. while + you were testing kit on deck) that you do not want to export. Use + the select checkbox to pick all of the rows that you wish to + export, or right click on the table and "Select All." +
+ ++ When one or more deployment records are selected, the + "Export..." button will become available. Selecting the export + button will start a dialog that asks for additional information + about the deployments and then write records to Tethys. +
++ The first page of the dialog asks for the project and geographic + region which will be automatically populated if they have been + previously specified. In addition, the following fields are + requested: +
++ The next page of the dialog asks whether you would like to + export a single deployment document or multiple deployments. + todo: add more detail here +
+ + ++ Finally, you are prompted to provide optional textual descriptions of: +
+ The bottom left panel shows a list of different types of + PAMGuard data that can be exported. The data in this list + correspond to the various PAMGuard modules that have been + configured. See the + + data model viewer + help for an example of how PAMGuard might be configured. +
+ ++ In the sample data blocks image below, four modules have been + configured, but only one of them has been run. Column "N Pam + Data" indicates the number of data records that have been + produced, and "PAMGuard Time" tells us when the data were + processed. "Tethys Documents" indicates how many Tethys records + have been produced, and should be 0 until the data are exported. +
+ + +
+ 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.