.. UHDAS+CODAS documentation master file, created by sphinx-quickstart on Wed Jan  7 14:24:39 2009.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

UHDAS+CODAS Documentation
=========================

An **ADCP** (Acoustic Doppler Current Profiler) is a device made by
`Teledyne RD Instruments <http://www.rdinstruments.com>`_ that uses
the Doppler frequency shift of an acoustic ping to infer water
velocity.  It is a registered trade name.   ADCPs are
attached to moorings, lowered on CTD rosette packages, and mounted on
ship hulls.  This web site deals with shipboard ADCPs.  An overview of
shipboard ADCP systems was written for the GO_SHIP  `Repeat Hydrography
Manual <http://www.go-ship.org/HydroMan.html>`_. For convenience, an
html version of the shipboard ADCP contribution is included
`here <best_practices.html>`_.

A **CODAS** (Common Ocean Data Access System) database is a way to
store and access oceanographic data. CODAS was developed in the late
1980's as a portable, self-describing format for
oceanographic data, with emphasis on processed
ADCP data.

"**CODAS processing**" refers to the ADCP data processing software
and procedures that were developed around the CODAS format.
The processing steps have become increasingly automated, but human
judgement is still required for the final product, and the software
is highly flexible in allowing manual configuration and execution of
individual steps.

"**UHDAS**" (University of Hawaii Data Acquisition System)
acquires data from  RDI ADCPs and ancillary sensors
(eg. gps, gyrocompass, gps and inertial attitude sensors...)
and uses CODAS processing
to incrementally build a dataset of averaged, edited ocean velocities
for each ADCP and ping type specified.  Processed data and plots
are served on the shipboard network, and daily status summaries are
emailed.

.. NOTE::
    **UHDAS** is not a program, but a complex set of codes and
    system configurations.  Setting up a new UHDAS installation
    requires Linux system administation skills, an understanding
    of UHDAS, and detailed knowledge of the particular suite of
    instruments and network environment on the ship.  We are
    working to make the installation process easier and more
    automated, but at present it is not sufficiently documented
    to be done without specific training.

CODAS documentation has accumulated over the years as acquisition programs,
instruments, and processing programs have changed. Some of the old
(but highly detailed) documentation contains references that are
obsolete, but still relevant to old data sets; and many of the problems
described in the old documentation still occur.

UHDAS+CODAS Documentation is evolving, as we gradually include
more of it under the unifying framework facilitated by
`Sphinx <http://sphinx.pocoo.org/>`_.
The full documentation  is available at various entry points:

    *  http://currents.soest.hawaii.edu/docs/adcp_doc/index.html

    * at sea on vessels with UHDAS acqusition systems, at

      http://currents/adcp

    * on your computer, if you install the CODAS suite of ADCP
      processing software


Contents:

.. toctree::
   :maxdepth: 2

   Codas processing <codas_doc/index>
   Codas installation <codas_setup/index>
   UHDAS Science Details <UHDAS_scidoc/index>
   UHDAS Technical details <UHDAS_webdoc/index>
   adcp_info/index
   appendix
   codas_doc/CODAS_FAQ

.. Indices and tables (not implemented)
    =======================================

    * :ref:`genindex`
    * :ref:`modindex`
    * :ref:`search`