Skip to content

Commit

Permalink
Started basic command-line usage docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
fnoble committed Nov 22, 2012
1 parent d2d95e6 commit 31b84e2
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ User Documentation
:maxdepth: 1

installation
usage
interactive
logging
samples
Expand Down
32 changes: 32 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
==================
Command-line Usage
==================

Peregrine can be used as a stand alone command-line tool for processing a
sample data file into a set of PVT solutions.

Usage information can be obtained by running::

$ peregrine --help

At its most basic, peregrine can simply be passed the name of a sample data
file to process and it will perform acquisition, tracking and navigation
solution on the data file::

$ peregrine path/to/sample_data_file

After each stage (acquisition, tracking and navigation solution), a 'results'
file is saved with the same name as the data file with the extensions
``.acq_results``, ``.track_results`` and ``.nav_results`` appended. These files
can be used for analysis at a later point or can be used to re-run peregrine,
skipping stages by loading their results from disk.

For example, to skip acquisition specify the ``-a`` option::

$ peregrine -a sample_data_file

and peregrine will attempt to load the acquisition results from the file
``sample_data_file.acq_results`` and skip straight to tracking.

Similar options ``-t`` and ``-n`` exist for tracking and navigation respectively.

0 comments on commit 31b84e2

Please sign in to comment.