Installation
This section describes how to install the software contained in the pds3-product-tools package. The following topics can be found in this section:
System Requirements
The following sub-sections detail the system requirements for the tool.
Java Requirement
The Product Tools software was 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.6 and has only been tested with this version. The following commands test the local Java installation in a UNIX-based environment:
% which java
/usr/bin/java
% java -version
java version "1.6.0_26"
Java(TM) SE Runtime Environment (build 1.6.0_26-b03-384-10M3425)
Java HotSpot(TM) 64-Bit Server VM (build 20.1-b02-384, mixed mode)
The first command above checks whether the java executable is in the environment's path and the second command reports the version. If Java is not installed or the version is not at least 1.6, Java will need to be downloaded and installed in the current environment. Consult the local system administrator for installation of this software. For the do-it-yourself crowd, the Java software can be downloaded from the Oracle Java Download page. The software package of choice is the Java Standard Edition (SE) 6, either the JDK or the JRE package. The JDK package is not necessary to run the software but could be useful if development and compilation of Java software will also occur in the current environment.
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 web page.
Unpacking the Tools Package
Download the pds3-product-tools package from the Product Tools Library web page. The binary distribution is available in identical zip or tar/gzip packages. The installation directory may vary from environment to environment but in UNIX-based environments it is typical to install software packages in the /usr/local directory and in Windows-based environments it is typical to install software packages in the C:\Program Files directory. Unpack the selected binary distribution file with one of the following commands:
% unzip pds3-product-tools-4.3.0-bin.zip
or
% tar -xzvf pds3-product-tools-4.3.0-bin.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 pds3-product-tools-4.3.0 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.
- doc/
This document directory contains a local web site with the Product Tools Library documentation, javadoc, unit test results and other configuration management related information. Just point the desired web 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 (pds3-product-tools-4.3.0.jar) containing the Product Tools Library software.
- src/
This directory contains the jar files with the source code for the Product Tools Library software.