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

.. _demos:


Demos: Postprocessing, adcp_database_maker.py, and commandline
---------------------------------------------------------------

The post-processing tutorial demonstrates typical steps to take
with a UHDAS dataset acquired at sea.

The two datasets we will process, **UHDAS** and **VmDAS** data, will
be demonstrated using `adcp_database_maker.py
<adcp_database_maker_demos/ADM_adcp_database_maker_intro/index.html>`_.
Additional demos will show how to obtain the same
data results using  command-line steps.

The processing examples below use the data from the ``adcp_py3demos*.zip``
files mentioned in the `CODAS Installation instructions
<../../codas_setup/index.html>`_. Paths given below match the
**virtual computer**, for simplicity.  For example, on the virtual
machine:

 - the ``adcp_py3demos`` source is in: ``/home/adcpcode/programs/adcp_py3demos``
 - the examples use ``~/my_adcp_py3demos`` to do the demos.


Instructions for each processing example exist in four places:

  - **using adcp_database_maker.py**: these ``adcp_py3demos`` tutorials

  - **basic instructions**: ``quick_adcp.py`` `command-line help
    <../quickpy_doc/quick_help.html>`_

  - **annotated instructions**: see links in each section

  - **with metadata**: the text files associated with the processing (in
    the ``adcp_py3demos/adcp_pyproc``  directories) have
    the same (basic) instructions, with additional meta-data included.
    These completed files are a good example of what to submit with
    your data when you send it in to the Joint Archive for Shipboard ADCP,
    `JASADCP <http://ilikai.soest.hawaii.edu/sadcp/>`_


.. NOTE:: **You really need to do the postprocessing demo first.**  Then
          Then it's relatively easy to go through the steps necessary
          for your scenario using ``adcp_database_maker.py``.  If for some
          reason that doesn't work, the last set of demos shows you the actual steps
          going on behind the scenes, in case you need to do things more manually.
          `This table <procfigs/demo_layout.png>`_ has a little more detail
          about the manual commands used in the processing.


.. _demolinks:


.. toctree::
   :maxdepth: 2


   intro/index
   postprocessing/index
   adcp_database_maker_demos/index
   commandline_demos/index