Operation

This document describes how to operate the Generate Tool software. The following topics can be found in this document:

Note: The command-line examples in this section have been broken into multiple lines for readability. The commands should be reassembled into a single line prior to execution.

Tool Execution

Generate Tool can be executed in various ways. This section describes how to run the tool, as well as its behaviors and caveats.

Command-Line Options

The following table describes the command-line options available: 

 -b,--base-path <base path mask>     Specify the base file path mask to be
                                     stripped from the input file path to allow
                                     output in a relative directory structure.
                                     Requires -o flag to also be specified.
 -d,--debug                          Verbose debugging output. Shows each step
                                     of parsing and label generation.
 -h,--help                           Display usage.
 -o,--output-path <output path>      Specify an output path to output the new
                                     PDS4 labels. By default, the file will
                                     output in same location as the input file.
 -p,--pds3-label <pds3 label>        Parse the file or list of files as PDS3
                                     Standard labels (also applicable for VICAR
                                     labels).
 -t,--template <velocity template>   Specify the file path for the Velocity
                                     template used to convert of the
 -V,--version                        Display application version.

Execute Generate Tool

This section demonstrates execution of the tool using the command-line options. The examples below execute the tool via the batch/shell script.

The following command demonstrates how to run the Generate Tool to convert from a PDS3 Label to a PDS4 Label using a Velocity template file and output to a file: 

% generate -p <pds3-label-path> -t <velocity-template-path>

The output would go into a file <pds3-label-path>.xml (i.e. $HOME/mpf123.img -> $HOME/mpf123.xml

The following command demonstrates how to run the Generate Tool to convert from a PDS3 Label to a PDS4 Label using a Velocity template file and output all debug information to standard out: 

% generate -d -p <pds3-label-path> -t <velocity-template-path>