Command-line help

Note

As of April 2013, this version of the documentation is no longer maintained; however, it is consistent with the last (now retired) version of CODAS processing that used Matlab. We no longer update or fix the Matlab processing code, but we will maintain the Matlab code that reads CODAS Matlab output. Although the notes refer to both Python and Matlab processing, none of the code here will be maintained. This (now retired) documentation and code will remain available for awhile longer.

Python processing code is actively maintained and developed, and CODAS Python processing is documented here.

Help is available using the following two commands:
  • adcptree.py --help
  • quick_adcp.py --help

and in the links below.

adcptree.py:

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

quick_adcp.py:

This is the command used to run the CODAS ADCP processing steps:

MATLAB PROCESSING
  • quick_adcp.py --commands  ltamat: example for LTA or STA
  • quick_adcp.py --commands  enxmat: example for ENX
  • quick_adcp.py --commands  ensmat: example for ENS
  • quick_adcp.py --commands  uhdasmat: example for UHDAS

PYTHON PROCESSING

  • quick_adcp.py --commands  ltapy: example for LTA or STA
  • quick_adcp.py --commands  enrpy: example for ENR
  • quick_adcp.py --commands  uhdaspy: example for UHDAS

Note

CODAS processing can be performed with one of two processing “engines”: Matlab or Python. In either case Python is used as the scripting tool to drive the processing.