.. _quick_help:

Command-line help
---------------------------

Help is available using the following commands:
  - ``adcptree.py --help``
  - ``quick_adcp.py --help``
  - ``dataviewer.py --help``
  - ``patch_hcorr.py --help``

and in the links below.

adcptree.py:
++++++++++++++

This is the command used to create a new ADCP processing directory tree:

    * ``adcptree.py --help`` :ref:`(help here) <adcptree_summary_help>`

quick_adcp.py:
++++++++++++++++

Run this command for CODAS ADCP processing steps ...


... the **first** time

    * ``quick_adcp.py --cntfile q_py.cnt``

... **all subsequent** times

    * ``quick_adcp.py --steps2rerun`` (with various options to choose from)

    **General Help**

    * ``quick_adcp.py --help`` (:ref:`here <quick_adcp_help>`)
    * ``quick_adcp.py --vardoc`` (:ref:`command-line options <quick_adcp_vardoc_help>`)


    **PYTHON PROCESSING EXAMPLES**

    * ``quick_adcp.py --commands  postproc`` (:ref:`postprocessing <quick_postproc_help>`)
    * ``quick_adcp.py --commands  ltapy`` (:ref:`LTA or STA <quick_ltapy_help>`)
    *  ``vmdas_quick_ltaproc.py --help`` (:ref:`LTA or STA  <vmdas_quicklta_proc_help>`)
    * ``quick_adcp.py --commands  uhdaspy`` (:ref:`UHDAS <quick_uhdaspy_help>`)
    * ``quick_adcp.py --commands  enrpy`` (:ref:`ENR <quick_enrpy_help>`)
    * ``quick_adcp.py --commands  pingdata`` (:ref:`PINGDATA <quick_pingdata_help>`)



dataviewer.py
+++++++++++++++

    *  ``dataviewer.py --help``  :ref:`(help here) <dataviewer_help>`