$Date$ $Author$

README for channelflow source code distribution.

See INSTALL for compilation and installation instructions.
See doc/TUTORIAL for a basic introduction to channelflow usage.
See examples/README, for writing and compiling your own channelflow programs.
See docs/userguide/channelflow.tex for a discussion of channelflow design,
    algorithms, and library usage. Available as PDF online at
    http://www.channelflow.org/documentation/channelflow_manual.pdf


This file describes the directory structure and components of the
channelflow source code distribution. Channelflow follows standard GNU
packaging structure as much as possible. The main subdirectories are

channelflow/     the channelflow library source code
programs/        executable programs
programs-octave/ executable programs that require octave libs
examples/        how to write and compile your own channelflow program
matlab/          Matlab scripts for plotting channelflow data
tests/           a suite of test programs for the library code
data/            a few data files useful for the test programs
doc/             tutorial, timing results
doc/userguide/   in-depth LaTeX documentation
obsolete/        obsolete code that might be brought back



John F. Gibson

Center for Nonlinear Sciences
School of Physics
Georgia Institute of Technology
Atlanta, GA 30332-0430

gibson@cns.physics.gatech.edu