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 product-tools package. The following topics can be found in this section:

System Requirements

Java Requirement

The tools contained in the product-tools 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. Other 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 Tools Package

Download the product-tools package from the PDS Software Download web page. The binary and source distributions are 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 product-tools-X.X.X.zip
or
[node: ~] tar -xzvf product-tools-X.X.X.tar.gz
      

Unpack the selected source distribution file with one of the following commands (where X.X.X is the current version):

[node: ~] unzip product-tools-X.X.X-src.zip
or
[node: ~] tar -xzvf product-tools-X.X.X-src.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.

Binary Distribution

The binary distribution related commands above result in the creation of the product-tools-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.

  • docs/

    This document directory contains a local web site with the Product Tools 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 (product-tools-X.X.X.jar) containing the product tools software.

Source Distribution

The source distribution related commands above result in the creation of the product-tools-X.X.X directory with the following directory structure:

  • README.txt

    A README file that will contain useful information on how to build the software in a future release.

  • 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 cla ssified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.

  • build.xml

    The Ant script for building the product tools software.

  • maven.xml

    The Maven goals for the product tools software.

  • project.properties

    The Maven properties for the product tools software.

  • project.xml

    The Maven Project Object Model (POM) for the product tools software.

  • defaults/

    This directory contains the Maven default settings and site layout for building the product tools software.

  • src/

    This directory contains the source code files for the product tools software.

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