Tethys Documentation

Manuals

These manuals require a portable document format (PDF) viewer.

  • Tethys - Main manual, provides comprehensive overview of the software.
  • Data Explorer - Program run on your local machine that provides a web-based method of exploring Tethys data without requiring extensive knowledge about Tethys.
  • Web Client - The web client is an interface provided by the Tethys server that lets one query and save data, import data, and access the help system (this page).
  • Tethys clients - Language-specific interfaces for people wishing to interact with Tethys from a specific programming language. Designed for large-scale analysis.
    • MATLAB - Cookbook style tutorial manual (same material as in tutorial-style list below)
    • R
    • Java
    • Python - Python documentation has not been written yet, but the client code is relatively well-documented and contains an example query.
  • Nitty gritty - Information on more complex aspects of Tethys, usually only of interest to programmers or IT administrators.
    • Nilus XML Generator - A Java library for generating Tethys-compliant XML from DCL algorithms. Can be used from any language that can call Java (e.g., MATLAB).
    • Web Services Interface - Tethys uses a RESTful architecture to provide services between the server and client. This documents the REST specification.
    • Secure Socket Layer - Information on running Tethys over an encrypted channel (secure socket layer).
    • Application programming interface documentation - While not available from this help system, JavaDoc APIs are avaialble for Nilus and the Java client. See file target/apidocs/index-all.html which is present for these clients.

Tutorial-style Manuals

These documents are designed to be more tutorial in nature.