SIAM Software

Introduction

SIAM software, written in Java, implements functionality in the MOOS Deployed and Operations subsystems. The ISI infrastructure is contained in the "org.mbari.isi" package hierarchy; MOOS-specific code is in the "moos" package hierarchy. The "javadoc" description of the software can be found here.

This document describes the build process for SIAM software. The development/build environment for this software is similar to that described at Geosoft. The software "project" consists of several Java packages.

Prerequisites

You must use GNU make to build the software.

The following three environment variables must be set prior to making the software:

JAVA_HOME - Points to the Java distribution that is being used, for instance /usr/local/jdk1.3. All Java tools used by the make system are referred to through this pointer; thus changing to a different Java version is as simple as resetting this variable.
JAVA_DEV_ROOT - Points to your development root directory for this project, e.g. /home/oreilly/siam. The project directory tree must be installed in this location.
IS_UNIX - Should be set to true if the development platform is UNIX and left unset (default) if it is not. This variable is needed for the sole purpose of getting the file separator token used by the Java tools correct. (It is ';' on MS-Windows and ':' on UNIX.)

Running Make

Using the make system is quite simple. You will run it from either the package level or from the project level.

The following commands can be run from the package level (i.e within a given package directory):

   make - Process all source files in given package

   make clean - Remove all produced files of given package

   make SomeFile.class - Produce a specific file.

The following commands can be applied from the project level (i.e while in the $JAVA_DEV_ROOT/ directory):

   make - Process all source files in all packages

   make clean - Remove all produced files in all packages

   make jar - Create all specified jar files

   make SomeJar.jar - Create a specific jar file

   make javadoc - Create documentation for entire project