When Tethys is installed, documentation can be found in the docs folder contained in the folder where Tethys was installed (typically either C:Program FilesTethys or C:UsersYourAccountTethys). Documentation can also be accessed here.

User documentation

  • Introductory videos are available on the tutorials page.
  • Web Client manual – Provides documentation for how to query Tethys through a web browser and export data to Matlab, R, and XML.
  • Matlab cookbook – Quick and dirty recipes to get the reader started using Tethys using the Matlab client.
  • User manual – Large manual with details on installing, administering, and using Tethys.

Understanding how we represent data

  • Roch et al. (2016), Management of acoustic metadata for bioacoustics lays out many of the guiding principles of the data that we retain.
  • Our standards work has a narrative explanation of our data, explaining what we retain and why. Note that the standard is evolving and may differ from what is in the current distribution.
  • Tethys XML schemata (html, pdf)-are used as a concrete implementation of our data ontology. It is assumed that the reader has some familiarity with XML Schema. n introduction to understanding schemata in general is available in the Tethys user manual. For deeper understanding of XQuery, XPath, and XML Schema, we suggest consulting the following texts:
    • for XML Schema: Walmsley, P. (2002). Definitive XML Schema. Upper Saddle River, NJ: Prentice Hall PTR.
    • for XQuery and XPath: Walmsley, P. (2006). XQuery. Farnham, UK: O’Reilly

Technical documents for developers

  • Nilus support for generating Tethys compatible output from detection, classification, and localization algorithms – This manual is written for algorithm developers that wish to develop Tethys ready output as opposed to using Tethys’s import interface. In addition to the manual, class-level Javadocs generated from Nilus source code are also available.
  • Encrypted data transmission – Tethys can serve data over secure socket layer, a data transport method commonly used in web commerce such as banking. Using Tethys requires obtaining a certificate and public/private key pair, this document explains how to configure Tethys to use certificate based authentication and encryption.
  • The RESTful web services document describes the protocol for client programs to communicate with Tethys web servers.