spacer spacer spacer
spacer spacer spacer
spacer
NASA Jet Propulsion Laboratory, California Institute of Technology Vertical Bar + NASA Homepage

+ NASA en Español

+ Contact NASA

Installation

This section describes how to install the tools contained in the vtool package. The following topics can be found in this section:

System Requirements

Java Requirement

The tools contained in the vtool package were developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The tools were specifically developed under Sun Java version 1.4, so the tool will execute correctly under versions 1.4 or 1.5.

Since the tools are developed using Sun's Java, this is the preferred Java environment for operation. The Sun Java package can be obtained from the Sun Java web site. Oth er Java environments are relatively compatible with Sun's Java. Testing has been performed with GNU's Java environment. The result is that release 4.1.1 at a minimum is required for nominal operations.

Data Dictionary Requirement

Release 1r64 or later of the Planetary Science Data Dictionary (PSDD) is required for the tools to function properly. Release 1r66 of the PSDD supports the validation of explicit FILE objects. The latest version of the PDS data dictionary can be retrieved from the PDS Data Dictionary Lookup web page.

Unpacking the VTool Package

Download the vtool package from the PDS Software Download web page. The binary distribution is available in identical zip or tar/gzip packages. Unpack the selected binary distribution file with one of the following commands (where X.X.X is the current version):

[node: ~] unzip vtool-X.X.X.zip
or
[node: ~] tar -xzvf vtool-X.X.X.tar.gz
      

Note: Depending on the platform, the native version of tar may produce an error when attempting to unpack the distribution file because many of the file paths are greater than 100 characters. If available, the GNU version of tar will resolve this problem. If that is not available or cannot be installed, the zipped package will work just fine in a UNIX environment.

The commands above result in the creation of the vtool-X.X.X directory with the following directory structure:

  • README.txt

    A README file directing the user to the available documentation for the project.

  • LICENSE.txt

    The copyright notice from the California Institute of Technology detailing the restrictions regarding the use and distribution of this software. Although the license is strictly worded, the software has been classified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.

  • bin/

    This directory contains the executable jar file containing the Validation Tool software along with a batch and shell script for executing the tool.

  • docs/

    This document directory contains a local web site with the Validation Tool Guide, javadoc, unit test results and other configuration management related information. Just point your favorite browser to the index.html file in this directory.

  • lib/

    This directory contains the dependent jar files for the tool along with the jar file (vtool-X.X.X.jar) containing the Validation Tool software.

Modifying Shell Scripts

A batch file, VTool.bat , and shell script, VTool , are included in the vtool package to provide an easy way of running the Validation Tool on Windows and Unix-based environments, respectively.

In both the batch file and shell script, there is a variable named jarpath that needs to be modified before the scripts can be executed. The variable needs to be set to the correct location of the executable vtool jar file.

The following demonstrates the jarpath being set to the vtool jar file location. The example contains X.X.X , which should be replaced with the current version of the vtool package.

Note: The example has been broken into multiple lines for readability.

set jarpath = \
"/home/user/vtool-X.X.X/bin/vtool-X.X.X-app.jar"
      
FirstGov Logo
+ Freedom of Information Act

+ NASA 2003 Strategic Plan

+ NASA Privacy Statement, Disclaimer, and

   Accessiblity Certification


+ Copyright/Image Use Policy
NASA Logo
Curator: Emily.S.Law

NASA Official: William Knopf

Last Updated: 28 September 2007

+ Comments and Questions
spacer
spacer spacer spacer
spacer spacer spacer