quick_adcp.py components:
========================================
quick_adcp.py (Proc)
- initializes opts (warehouse of variables)
- contains primary documentation about variables (comments)
- Proc: gathers all the modules and commandline arguments
- checks arguments (
- determines what steps will be run
quick_setup.py (Q_setup)
- reads CRUISE_proc.py, tests opts,
- manages dbinfo.txt
- writes cruise_info.txt
quick_run.py (Q_run)
- wrapper to "run" one processing step:
- ask "run XXX now?"
- chdir(working_dir)
- call commands to
- write cnt file to disk (call Q_subs)
- run executable
- chdir(start_dir)
--- subroutines ---
# related to C-routines
quick_subs.py (Q_subs)
- subroutines to write cntfiles for C-routines
quick_asect.py (Q_asect)
- routines involving adcpsect
# related to python
quick_mpl.py (Q_mpl) subclass Scripter for calculations using numpy
quick_npy.py (Q_npy) subclass Scripter for calculations using matplotlib
NOTE: quick_mpl.py and quick_npy.py write a stub (XXX_Script.py) suitable
for editing and running in Python. This makes the classes more
complicated than they really need to be (related to initializing and
passing in arguments)
---- documentation ---
quick_docs.py (functions to print documentation)
- vardoc (should echo what is in quick_adcp.py opts initialization)
- print_XXX_commands: (echo the readme from demo processing)
=======================================================
