This document describes how to install the Registry Tools contained in the registry-tools package. The following topics can be found in this document:
This section details the system requirements for installing and operating the Registry Tools software.
The Registry Tools software was developed using Python and will run on any platform with a supported Python environment. It is compatible with Python 2.6 or 2.7. It is not compatible with Python 2.5 or earlier versions, nor with Python 3 or later versions. The following commands test the local Python installation in a UNIX-based environment:
% which python
/usr/bin/python
% python --version
Python 2.7.2
The first command above checks whether the python executable is in the environment's path and the second command reports the version. If Python is not installed or the version is not 2.6 or 2.7, Python will need to be downloaded and installed in the current environment. Consult the local system administrator for installation of this software.
The Registry Tools software has a dependency on the Registry Client software package. Follow the instructions in the Registry Client Installation document to install that package in your environment. If viewing this document from the registry-tools package, view the Registry Client Installation document from the Engineering Node site.
Download the registry-tools package from the PDS FTP site. The 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 distribution file in the installation directory for the local environment with one of the following commands:
% unzip registry-tools-1.13.0-bin.zip
or
% tar -xzvf registry-tools-1.13.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 registry-tools-1.13.0 directory with the following directory structure:
A README file directing the user to the available documentation for the project.
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.
This directory contains the Python scripts for launching and interacting with the software for UNIX-based and Windows environments.
This directory contains a local web site with the Registry Tools documentation and other configuration management related information. Just point the desired web browser to the index.html file in this directory.
In order to manage and interact with the Registry Tools, the local environment must first be configured appropriately. This section describes how to setup the user environment on UNIX-based and Windows machines.
This section details the environment setup for UNIX-based machines. The distribution includes Python scripts that must be executed from the command-line. Setting the PATH environment variable to the location of the scripts, enables the scripts to be executed from any location on the local machine.
The following command demonstrates how to set the PATH environment variable (in Bourne shell), by appending to its current setting:
% export PATH=${PATH}:/usr/local/registry-tools-1.13.0/bin
This section details the environment setup for Windows machines. The distribution includes Python scripts that must be executed from the command-line. Setting the PATH environment variable to the location of the files, enables the scripts to be executed from any location on the local machine.
The following command demonstrates how to set the PATH environment variable, by appending to its current setting:
C:\> set PATH = %PATH%;C:\Program Files\registry-tools-1.13.0\bin
Additional methods for setting Windows environment variables can be found in the Windows System Properties document.