Overview

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.

Because we want to support a reasonable number of operating systems, versions of support code, and hardware, we can no longer distribute pre-built binaries. CODAS installation requires installation of several packages from different sources, compilation of the C programs, and installation of supporting packages. This means there are several web sites to visit and programs to install, but the result is a highly functional free (for Python processing), open source processing package.

This will provide you with a recent tested CODAS installation that works with most datasets produced by UHDAS, VmDAS, or DAS2.48 for the following RDI ADCPs:

  • OS150, OS75, OS38
  • NB150, NB300
  • WH300
  • BB75

Our source code and most documentation are now in Mercurial repositories to allow version control, documentation of changes, and access over the web. The actively-maintained code base is here. The code base that is consistent with this now obsolete documentation is on the web, here

There are a still a few zip files to download to complete the CODAS suite.

Bug fixes and improvements will not be made to this now obsolete code base, so there is no updating. But if you switch to the NEW code base, and use all-Python processing, updates will be available in the Mercurial distribution after testing; see this link for instructions about updating the CODAS component. Mercurial facilitates updates, but you will need to recompile the code after updating.

CODAS suite: components and purpose

This is a summary of packages and the reason for downloading them

  • M : required for Matlab processing
  • P : required for Python processing

Note

If you intend to process with Python at all, go to the new documentation and follow those instructions. This now retired documentation will not lead you to a happy Python experience.

Package     Purpose
       
python packages      
python M P “quick_adcp.py” runs processing steps
mercurial   P version control, download or update CODAS software
scons M P system for compilation instructions for C programs
numpy   P replaces the numerical component of matlab
matplotlib   P replaces the graphical component of matlab
basemap   P replaces the m_map for use with topography
requires installation of a bathymetry product
wxPython     all CODAS Python graphical tools use WxPython
  • codas “gautoedit” editing in Python
  • codas data viewer
  • make an ADCP web page using “quick_web.py”
ipython   P powerful interactive Python shell; plays well with matplotlib to create an interactive environment
C Compiler M P Required: compile CODAS executables
Matlab M   Code base (along with C) used for processing from Early Days through 2010. Functionality has been by Python.

This table shows what the now retired code base can process, and this new python processing table to see what is supported in the new all-Python code base.

Installation Steps

To install the CODAS suite on your computer, work your way throught these steps. DO read about versions; there are specific guidelines about what will work or not work for each operating system.

  1. Install Python.
  2. Download CODAS programs
  3. Get supporting tools and compile (compiler and build tool)
  4. Set up your paths:
  5. Install Matlab
  6. Python packages: (numpy, matplotlib, basemap)