Installation Notes for TIBCO Spotfire S+ 8.1 for UNIX/Linux
(November 2008)

This file contains brief instructions for installing Spotfire S+ 8.1. 


SUPPORTED PLATFORMS AND SYSTEM REQUIREMENTS

The 32-bit version of Spotfire S+ 8.1 for UNIX/Linux is supported on the 
following platforms and operating systems. The minimum recommended disk space
for installing and running Spotfire S+ is also included:

Platform Operating System                                 Required Disk Space
-----------------------------------------------------------------------------
Solaris 2.8, 2.9, 2.10 (SPARC)                            475 MB
Red Hat Enterprise Linux 5 (Intel/AMD)                    475 MB
Red Hat Enterprise Linux 4 (Intel/AMD)                    475 MB
SUSE Linux Enterprise 10 Service Pack 2 (Intel/AMD)       475 MB

The 64-bit version of Spotfire S+ 8.1 for UNIX/Linux is supported on the
following platforms:

Platform Operating System                                 Required Disk Space
-----------------------------------------------------------------------------
Red Hat Enterprise Linux 5 (Intel/AMD)                    500 MB
Red Hat Enterprise Linux 4 (Intel/AMD)                    500 MB
SUSE Linux Enterprise 10 Service Pack 2 (Intel/AMD)       500 MB

Note that Spotfire S+ no longer supports HP-UX or AIX.

Note that previous versions of the listed operating systems may function
with Spotfire S+, but they are not supported.

The minimum RAM required to run Spotfire S+ from the command line is
roughly 60 MB. The Java GUI* requires an additional 100 MB. Note that these 
values are the minimum requirements; if you work with moderately sized data 
sets, these numbers may be insufficient for your needs. 

     *The Java-based GUI is deprecated in Spotfire S+ 8.1.
      If you want to use a GUI with Spotfire S+ for UNIX/Linux, 
      use the Spotfire S+ Workbench.


Eclipse 3.4.0, the version that Spotfire S+ 8.1 uses, does not support 
SPARC/Motif for Solaris. If you are using a version of Solaris 
prior to version 10, you must install the GTK library. (This library 
is included in Solaris 10.)For more information about finding this 
library, see http://www.sun.com/software/solaris/ or 
http://sunfreeware.com/programlistsparc8.html#gtk (Solaris 8) or
http://sunfreeware.com/programlistsparc9.html#gtk
(Solaris 9). Note that gtk 2.2.4 (or higher) is required for Eclipse 3.4.0.
        
Java Runtime Environment (JRE)
   
    The Java runtime environment (JRE) version 1.6.0 is included  
    in Spotfire S+ 8.1. Your operating system must support  
    JRE 1.6.0 in order to run the Java-enabled version of Spotfire S+.  
    Note that the JRE provided by Spotfire S+ is installed as part  
    of the Spotfire S+ distribution, and under normal circumstances,  
    it is used only by Spotfire S+. If you have a different version of  
    the JRE on your system, the JRE used by Spotfire S+ should not
    interfere with your other JRE applications, which will 
    continue to use the version you have previously installed. 

    Platform specific requirements for JRE 1.6.0 can be found at
    http://java.sun.com/javase/6/webnotes/install/index.html.

  
GENERAL INSTALLATION INFORMATION

For more detailed information, please see the Spotfire S+ Installation
and Administration Guide for Windows and UNIX/Linux.

1) Create a new directory for the Spotfire S+ tree, and cd to that 
directory. Be sure the directory you create is on a file system with adequate 
disk space. This directory can be in your home directory if you are going to be
the only user, or in a globally visible location if the installation is to
be shared by multiple users. In the latter case, we recommend you create a
special user account and group called splus, and use that account's home
directory as the installation directory. If you create such an account, log in
as splus to perform most of the installation.

2) Set permissions so members of the splus group can use Spotfire S+:

   umask 022

3) Unpack the tar file from the CD-ROM into the new directory using tar as
follows: 

   cat /[mount_point]/SPLUS.TZ | uncompress | tar xvf -

where [mount_point] is the absolute path to the CD-ROM drive. 

If you are installing as superuser (or root), the files should be restored
with the user and group identifiers that existed when the files were 
tarred. On Solaris, the -o flag to tar assigns these identifiers to the 
user extracting the files.

If your system has the GNU zcat command, you can use it to shorten your
extraction command (zcat combines the cat and uncompress commands):

   zcat /[mount_point]/SPLUS.TZ | tar xvf -

4) Within the new Spotfire S+ home directory, run the CONFIGURE script:

   ./CONFIGURE

The option "Destinations and name of Splus Script" is generally the only option
that most users will customize. For example, choosing 
"Destinations and name of Splus Script" leads to:

1:    Location for Splus shell script
2:    Name of Splus shell script
3:    About This Menu
0:    Return to Previous Menu

The first option sets the directory where the shell script used to start
Spotfire S+ 8.1 is installed. The default is usr/local/bin.

The second option allows you to change the name of the Spotfire S+ shell
script, which is 'Splus' by default. If you try to install the Spotfire S+
script in a directory that already has a script with the same name,
you will be prompted to enter a new location for the script, enter a new
name for the script, or overwrite the existing script. 
    
If you access Spotfire S+ 8.1 through NFS, you will need to
edit the Spotfire S+ script to make sure that SHOME (the 
installation directory) is set to a path that is recognized 
by all hosts on the network.

5) As root, run the INSTALL script:

   ./INSTALL

When you run INSTALL the Spotfire S+ script is placed into the 
directory specified in the previous step.


RUNNING Spotfire S+

Before starting Spotfire S+, you must do the following:

a. Set your DISPLAY environment variable to your local machine. 

Check if your DISPLAY variable is set already by looking at the 
output from 

   echo $DISPLAY

to be sure. To set your display from a C-like shell (csh, tcsh, etc.), 
use the setenv command: 

   setenv DISPLAY <display_name>

where <display_name> is the name of your local machine. From the Bourne-
and Korn-like shells (including sh, ksh, bash, etc.), use the following
commands: 

   DISPLAY=<display_name>;export DISPLAY

To use the Java related features of Spotfire S+, you must be able to
connect to your local X window server. Thus, you must have the
environmental variable DISPLAY set, and the X window server on your
local machine must allow the Spotfire S+ server to create windows on your
machine; see the UNIX programs xauth or xhost. Typically, if you
can run xclock on your machine, then Spotfire S+ should also be able
to access the X server.

b. Download and install the pkgutils library (Spotfire S+ packages)

A package is a collection of Spotfire S+ functions, data sets, help files, 
and other code (written in C, C++, or Fortran) that you can distribute to 
other users. Downloading, installing, checking, and building Spotfire S+ 
packages requires the pkgutils library, which must be downloaded 
from the Comprehensive S Archival Network (CSAN) at 
http://spotfire.tibco.com/csan, and installed in your SHOME/library.

After you have installed Spotfire S+, enter the following from a UNIX/Linux 
shell prompt:
 
   ./INSTALL.PKGUTILS

This installs the pkgutils library in your SHOME/library, where SHOME is your
installation directory. You must be connected to the Internet to run 
this script, and you must have permission to write in the Spotfire S+ installation
directory. Then enter

   library(pkgutils)

to load the pkgutils library and access the pkgutils functions. For more 
information on Spotfire S+ packages, see the release notes or the 
"Spotfire S+ 8 Guide to Packages," available in your SHOME/doc directory 
(spluspackages.pdf).

c. Create a Spotfire S+ chapter to hold your work.

Creating a Spotfire S+ chapter is necessary for storing the data
objects and external files you create in Spotfire S+. The following
commands create a Spotfire S+ chapter named mysplus for you to work
in (be sure you don't have a mysplus directory in your home
directory before typing these commands):

   % cd
   % mkdir mysplus
   % cd mysplus
   % Splus CHAPTER

Note that if you do not create a chapter, Spotfire S+ automatically creates
one for you named MySwork the first time you start Spotfire S+.

You are now ready to start Spotfire S+. Spotfire S+ may be launched in a
variety of modes, and the following lists each mode and the
corresponding UNIX command-line expression for launching it. In
all of the commands below, Splus refers to the script you use to
launch Spotfire S+ 8.1 on your system.

To run Spotfire S+ from the command line without Java:

   Splus

To run Spotfire S+ from the command line supporting Java calls, Java graphics, and
the Java help interface:

   Splus -j

To run Spotfire S+ with the graphical user interface (GUI):

   Splus -g   or   Splus -g &

The second command using the ampersand "&" puts the GUI process
into the background, freeing your xterm for other uses.

To attach the Spotfire S+ Big Data Library before running Spotfire S+:

   Splus -bigdata 

To run the Spotfire S+ Workbench:

   Splus -w | -workbench

Spotfire S+ 8.1 includes two additional flags, -jit and -helpoff:

   * The -jit flag works with the -g, -j, and -userapp flags
     and allows you to turn on the Java just-in-time compiler.
     This makes the graphical user interface and help system
     run faster but introduces instabilities that often lead to crashes. 
     In particular, the just-in-time compiler often crashes while
     repainting graphical user interface elements such as the JavaHelp 
     window and the Data window.
 
   * The -helpoff flag is useful only with the -g flag. It turns
     off the automatic invisible startup of the help system. 
     The invisible startup improves initial responsiveness
     of the help system but adds a significant memory footprint
     to the current session. If you wish to optimize your
     available memory, this flag may prove useful.




