7.7.9. dataviewer_help.txtΒΆ

Script for ADCP CODAS data viewer.

**Usage**

    *view mode: view CODAS database*
        call from from a processing directory: dataviewer.py
        call from anywhere                   : dataviewer.py path/to/proc/dir

    *editing mode: `gautoedit`*
        call from processing "edit" dir      : dataviewer.py -e

    *singleping viewer (UHDAS only, correct configuration files in place)*
        call from processing "edit" dir      : dataviewer.py -p
        call from processing "edit" dir      : dataviewer.py -p [options]

    *compare 2 databases*
        call from anywhere:    dataviewer -c path1 path2

**Arguments**
    *path*
        path to processing directory or sonar name

**Options**
    *modes*
    -v [--view]      view codas adcp data
    -e [--edit]      edit codas adcp data
    -p [--ping]      view codas and singleping data
    -c [--compare]   view (compare) data from 2 sonars

    *color plots*
    -s [--step]      steps, duration (days) to view in panels
    -n [--numpanels] number of panels (<= 12)
    -t [--title]     title for panel and topo plots (overrides default)

    *topo. map*
    -m [--minutes]   number of minutes to average in topo. map
    --zoffset        subtract this altitude from all topography
    --vecscale       vector scale: larger number shrinks vectors
    --ref_sonar      name of the reference sonar (only in compare mode)

    *data*
    --dbname         path to database (up to but not including 'dir.blk')
    --startdday      decimal day to start
    --sonar          such as 'os38bb', 'wh300', to read raw data
    --netcdf         path to NetCDF file (*.nc)

    *accessibility*
    --whitebg        show pcolor masked (bad) values as white
    --colorblind     switches on colorblind friendly color schemes

    *logging*
    --debug          If present, switches on debug level logging.
                     Optional argument is debug_file_path
                     (default being ./debug.log)

    *for expert only*
    --advanced       enables advanced forensic thanks to
                     a custom Ipython console

    *for edit , compare and single ping modes only*
     These parameters might be needed if 'dbinfo' is insufficient
      (or not exist):
    --cruisename     base name for configuration file
    --beamangle      angle of the ADCP beams, in deg., upward from vertical
    --configtype     read 'python' (default) or 'matlab' config files
    --ibadbeam       index of the non-working beam, (1, 2, 3 or 4)
                     (see RDI manual)
    --uhdas_dir      path to directory containing 'raw', 'rbin' and 'gbin'

    *setting file*
    --setting_file   path to setting file. One can specify all the above
                     options (and more) via a *.ini file.
                     (see pycurrents/*MODE*_setting_template.ini)
                     N.B.: the options specified the in *.ini will override
                           the related command line options.
    *progress file*
    --progress_file  path to progress file (.pgrs). For a given cruise,
                     this file will bring the user back to his/her previously
                     saved progression.
                     N.B.: the options specified the in *.pgrs will override
                           the command line and/or *.ini options.

**Examples**::

   dataviewer.py path/to/cruiseID/sonar -n 3 -t sonar
   dataviewer.py -c path/to/sonar1 path/to/sonar2