Installation

This document describes how to install the PDS4 Tools software contained in the pds4-tools package. The following topics can be found in this document:

• System Requirements
• Unpacking the Package

System Requirements

The PDS4 Tools software was developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The software was specifically developed under 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.

Unpacking the Package

Download the pds4-tools package from the PDS FTP site. 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 pds4-tools-0.1.0.zip
or
% tar -xzvf pds4-tools-0.1.0.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 pds4-tools-0.1.0 directory with the following directory structure:

• index.html
  

  An HTML file containing the documentation for the software.

• readme.txt
  

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

• bin/
  

  This directory contains batch and shell scripts for executing the example program.

• doc/
  

  This directory contains the javadoc documentation.

• examples/
  

  This directory contains an example driver program and example data files.

• lib/
  

  This directory contains the dependent jar files for the software along with the jar files containing the PDS4 Tools software.