SIAM Quick Start Guide

Follow these steps to install SIAM and run example instrument services

• Install 3rd party packages
  • Java SDK 1.3 or higher
  • GNU Make 3.80 (3.81 and above aren't compatible with Windows/Cygwin)
  • bash shell
  • RXTX 2.1-7r2
• Install SIAM source tree
  • tar xzvf <siam-version>.tar.gz
  • creates siam2 directory
• Configure environment variables
  • source sample environment file appropriate for your system (in SIAM_HOME/docs/siam-site/content/examples):
  • source siam-env.<your OS> <path to SIAM_HOME> <path to JAVA_HOME>
  • example environment files are available from example index
• Create directories
  • cd $SIAM_HOME
  • mkdir classes
  • mkdir codebase
  • mkdir ports
  • mkdir logs
• Build SIAM Java sources
  • cd $SIAM_HOME
  • make
• Build siamjar
  • make siamjar
• Build instrument service JAR files
  • make example.all
  • creates instrument service JAR files in SIAM_HOME/ports
  • example makefile and shell script are available from example index
• Configure example siamPort.cfg
  • cp $SIAM_HOME/docs/siam-site/content/examples/siamPort.cfg.example $SIAM_HOME/properties/siamPort.cfg
  • edit $SIAM_HOME/properties/siamPort.cfg
  • set the codebase parameter to point to your codebase directory, e.g. /Users/joe/code/siam2/codebase (siamPort.cfg does NOT expand environment variables)
  • example siamPort.cfg is available from example index
• Start the SIAM application
  • cd $SIAM_HOME
  • node &
• You're up and running!

Log files created by the instrument services and the SIAM application will be written to the SIAM_HOME/logs directory (or the directory (relative to SIAM_HOME) specified in siamPort.cfg).

Now try some SIAM utilities...

• Use the listPorts utility to verify that the services are running
  • listPorts localhost -stats
  • should return

        adrift:siam2 user$ listPorts localhost
        SIAM version $Name:  $
    							
        Node 10005 has 3 ports
    							
        Port Name ISI-ID   Service   Status 
        --------- ------   -------   ------ 
        test   9990          Dummy SLEEPING 
        sbe37  9992 DummySeabird37       OK 
        co2    9995      DummypCO2       OK 
    							

• Use getLastSample to look at most recent data
  • getLastSample localhost sbe37
  • should return

        adrift:siam2 headley$ getLastSample localhost sbe37
        SIAM version $Name:  $
        parentID=10005, recordType=0
        devid=9992, t=1295051771952, seqNo=3, mdref=2
        nBytes=100
        **
         *I*|****=****=**Kgt***Ys****~*"***	7R*;*****:****F**G*o;5E*p*@***E*_*F*)*2**1****iR*****v*3S***$C
    							

• To stop the SIAM application
  • exitNode localhost