NavManager

Contact: R2R Program, info@rvdata.us

Description

This code is designed to produce three navigation standard products from the primary GPS receiver onboard research vessels in the UNOLS fleet. Tools exist for finding basic quality parameters, flag bad points, and plot the data. For a full description of capabilities, please check out the cookbook provided.

Requirements

You will need a version of PHP that is at least 5.2 in order to use the built-in JSON functions: json_encode() and json_decode().

You will need a version of Java that is at least 1.5 in order to use the NavControl Java code.

If you wish to make basic maps of r2rnav products using the experimental navplot.php function, you must have GMT installed.

Installation

Clone the repository into a directory from which it can be run:

git clone git@github.com:rvdata/NavManager.git

You should add the absolute path name of where you placed these programs to your path environment variable.

For Mac users running bash:

cat 'PATH=$PATH:/path/to/r2r/NavManager/bin' >> ~/.bash_profile

For linux users running bash:

cat 'PATH=$PATH:/path/to/r2r/NavManager/bin' >> ~/.bashrc

For linux users running csh:

cat 'setenv PATH $PATH:/path/to/r2r/NavManager/bin' >> ~/.cshrc

Make sure to change the path in these commands to where your NavManager code actually resides.

Now you can type the name of the executable scripts on the command line and see a general description of what the code does and what arguments to specify.

Products

• NavBestRes - GPS position sampled at the highest rate in time (typ. once-per-second) with "bad" positions flagged.
• Nav1Min - NavBestRes sampled at once-per-minute
• NavControl - Nav1Min sampled using the Douglas Peucker algorithm to specify the minimum number of points to capture the general shape of a curve

Code Manifest

Executable scripts:

• bin/navcopy.php - Convert raw navigation data into the r2r standard format
• bin/navformat.php - Display supported input navigation formats.
• bin/navinfo.php - Get basic info on r2rnav files
• bin/navplot.php - Make a basic plot of r2rnav file (experimental; requires GMT 4+)
• bin/navqa.php - Performa a quality assesment report on r2rnav files
• bin/navqc.php - Flag bad values in r2rnav files
• bin/navsample.php - Downsample r2rnav files
• bin/navsogcog.php - Compute speed over ground and course over ground for r2rnav files

Documentation:

• doc/fileformat/format-nav[N].txt - Plain text files describing known fileformats (and content)
• doc/guide/NavManager_Cookbook.pdf - PDF file containing a cookbook for someone starting out with NavManager
• doc/bestpractices/Recommended-Best-Practices-for-Navigation-Data-Collection.pdf - PDF file describing recommendations to operators on best practices for navigation data collection

Libraries:

• include/decompressor.inc.php - Test for the presence of compressed files and uncompress them in your temporary work space.

• include/flags.inc.php - Defines the character used for flagging during quality control.

• include/getopts.php - Function to process command-line arguments.

• include/globals.inc.php - Contains global parameters.

• include/jsontools.inc.php - Function to pretty-print JSON given a PHP object.

• include/navbounds.inc.php - Calculate the geographic extent of the cruise (north, south, west, east).

• include/navconvert.inc.php - Convert R2R Navigation Standard format into MB-System nav format 1 (experimental)

• include/navcopy.inc.php - Read through all files in the datalist and translate them into R2R navigation standard format.

• include/navdatalist.inc.php - Create a date/time ordered list of raw navigation files.

• include/navheader.inc.php - Define product headers

• include/navqa.inc.php - Assess the quality of the navigation in standard format.

• include/navqc.inc.php - Flag "bad" navigation data. Output: NavBestRes

• include/navsample.inc.php - Sample the navigation data at a lower rate than originally sampled. No interpolation or filtering is performed

• include/navsogcog.inc.php - Calculate instantaneous speed over ground and course over ground and append columns to NavBestRes file.

• include/navtools.inc.php - Functions for calculating distance, speed, acceleration, azimuth, and geographic extent.

• include/nmeatools.inc.php - Classes for various NMEA messages.

• include/xmltools.inc.php - Function to write QA Report in XML format.

• include/xmltools2.inc.php - Function to write QA Report in the QA 2.0 XML format.

• include/NavControl/ - Contains Java code for creating control point navigation

• include/Templates/ - Contains XML templates