.. ......................................
.. UHDAS/CODAS restructured text document
.. ......................................


UHDAS proc (processed) data:
------------------------

The **proc** directory contains one CODAS processing
directory per instrument+pingtype.  For the example 
of a ship with an NB150 and an OS38, the processing
directories would be 

 * nb150
 * os38bb
 * os38nb

Pingtypes ("bb" and "nb") are processed separately 
because the singleping editing criteria are different, 
and because it is a useful diagnostic to compare the 
two datasets.  Averaging and merging can be done by 
the user after postprocessing.


Processing directory
~~~~~~~~~~~~~~~~~~~~~~~

CODAS processing is documented in more detail
`here <../../codas_doc/CODAS_quickdoc.html>`_.

The contents of a CODAS processing directory are
(in order of processing stages)


**directories: pre-processing and metadata**

  * ``config`` (metadata and processing configuration)
  * ``scan`` (charactierize timestamps, time range of data)
  * ``ping`` (default data location for pingdata, LTA, ENX (not UHDAS))
  * ``load`` (stage averages in the form of ``*.bin``, ``*.cmd`` files)
  * ``adcpdb`` (contains ``*.blk`` (the CODAS files))

**directories: CODAS processing**

  * ``nav``  (positions : reference-layer smoothing of positions here)
  * ``edit`` (editing of averaged (CODAS) data; plot temperature)
  * ``cal``
      - ``rotate`` (apply correction (time-dependent or constant))
      - ``watertrk`` (watertrack calibration calculation)
      - ``bottomtrk`` (bottomtrack calibration calculation)
      - ``rotate`` (testing effects of rotation; staging area)

**directories: output for users**

  * ``grid`` (staging lon/lat or time grid for data extraction)
  * ``vector`` (coarsly-gridded data, suitable for vector plots)
  * ``contour`` (finely-gridded data, suitable for contour plots)

  * ``png_archive`` (after "end cruise" on UHDAS installations, archive 
    of png files (one per day) from the at-sea web site)

**directories: quality and analysis**

  * ``quality`` (staging)
  * ``stick`` (staging: frequency decomposition)

**files**

  * ``adcp_processing.html`` (link to local documentation if CODAS
    processing code is installed locally on the computer)
  * ``cruise_info.txt`` (metadata and processing documentation template for user)
  * ``CRUISEID.runlog`` (output of most recent quick_adcp.py command)
  * ``INSTPING_qpy.cnt`` (control file used to process these data)