==========================================================================
======================== quick_adcp.py documentation =====================
==========================================================================

        run this                                to see this
    --------------                           ------------------
quick_adcp.py --help                        :        (this page)
                                            :
quick_adcp.py --overview                    : introduction to quick_adcp.py
                                            :      processing steps
                                            :
                                            :
                                            :
quick_adcp.py --howto_ping                  : HOWTO for pingdata
quick_adcp.py --howto_lta                   : HOWTO for LTA data
                                            :
quick_adcp.py --tips                        : tips for new users
                                            :
quick_adcp.py --varvals                     : print variables and current values
quick_adcp.py --vardoc                      : print documentation for variables
                                            :
                                            : simple example for:
                                            : ------------------
quick_adcp.py --commands  pingdata          :   pingdata files
quick_adcp.py --commands  LTA               :   LTA or STA files (averaged)
                                            :
quick_adcp.py --commands  singleping        :   single ping ADCP data overview
quick_adcp.py --commands  ENX               :   ENX files (earth coords)
quick_adcp.py --commands  ENS               :   ENS files (beam coords)
                                            :
quick_adcp.py --commands  UHDAS             :   UHDAS processing
quick_adcp.py --commands  template.txt      : template for record-keeping


unsupported/experimental:
------------------------------
quick_adcp.py --commands  HDSS              :  HDSS files (Pinkel's Revelle sonars)



NOTE to Windows users: replace 'quick_adcp.py' with 'quickadcp_py' and
                       replace 'adcptree.py' with 'adcptree_py'.  These
                       are .BAT files that set enviroment variables and
                       call the respective python versions.

NOTES:
- All these switches use TWO dashes attached to a word. If you use one
  dash or leave a space afterwards, it will fail.
- Wild cards:
      - use quotes on the command line: "pingdata.???" or "*.LTA"
      - do not quote in the control file
- There is a useful little perl script called "linkping.prl" which might
  help in getting pingdata files named sequentially if your cruise has
  multiple legs.
- APOLOGIES:
  (1) Matlab routines do not display feedback to the screen.  The only
      exception is in the 'load' stage, if you have Tk configured,
      you can use "--tktail" and a Tk window will pop up with feedback.
      In general however, the only way to see what is going on is to
      read the messages on the screen (from quick_adcp.py) to see where
      to look for more information.
  (2) Only pingdata and UHDAS have automatic generation of a heading
      correction (from a gps-aided device such as Ashtech).   There is
      a text file describing how to approach the heading correction
      if you look in the documentation (there is a link in the file
      created by adcptree.py)
==========================================================================