Fiswidgets Installation:

Files included in the fiswidgets-base-2.3.tar file after unpacking:

- jars	   fiswidget toolkit and application jar files
- doc     html documentation files 
		(See the help system instructions below.)
- scripts  optional fiswidget scripts for client / server mode
		(Go to http://neurocog.lrdc.pitt.edu/fiswidgets/fisdocs/cs_overview.html for details)
- fisproperties.default		A default .fisproperties file that should be configured
				for your site.
- classpath.default	A file containing a default CLASSPATH that should be configured for your site
- INSTALL  This file.


To install the Fiswidgets pkg do the following:

 1.  Make sure the Java JDK is installed for your system and in your PATH.
     To check on Unix and MacOSX systems, type in "which java".
     To check on Windows, you can look for installed programs in the "Add / Remove Programs" 
     in the "Control Panel".  If Java is not installed, go to http://java.sun.com to 
     download the latest version.
 
 2.  Move this directory (fiswidgets-2.3) to where you want to install the software.
     We typically put it in /usr/local/pkg or /usr/local/. 
           
 3.  Change the fisproperties.default so that the FISDOC_PATH
     is set to the full pathname of the directory that you have chosen.  .fisproperties is an ASCII
     (text editable) list of key/value fields.
 
 4.  Configure the rest of the fisproperties.default for your site and copy it to
     .fisproperties in your home directory.  

 5.  Set your CLASSPATH environmental variable so that all of the jar files
     in the jars directory are in your path.  Look at the classpath.default file
     and edit it for your site.


To install backend applications:
  Most Fiswidget GUI programs are front end wrappers to C/C++ commandline programs.
  You must install the commandline applications on your system as per the individual
  package install instructions.  Fiswidgets does not require any changes to the 
  backend programs.  
  The only part of the Fiswidgets package that needs to be compiled are the C/C++
  parts of the Tools package.  It is optional, it required only
  if you want to use the fiswidgets tools FormatConvert utility.


Testing:

  1.  Check that your CLASSPATH includes all necessary jar files (fiswidgets-system,
     fiswidgets-all, applications).  A typical CLASSPATH might look like:

     echo $CLASSPATH
/usr/local/pkg/ImageJ/ij.jar:/usr/local/pkg/ImageJ/plugins:/usr/local/java/jars
/fiswidgets-system.jar:/usr/local/java/jars/fiswidgets-all.jar:/usr/local/java/
jars/tools.jar:/usr/local/java/jars/air.jar:/usr/local/java/jars/air5.jar:/usr/
local/java/jars/nis.jar:/usr/local/pkg/ifis:/usr/local/java/jars/ifis.jar:/usr/
local/java/jars/afni.jar:/usr/local/java/jars/fiasco.jar:/usr/local/java/jars/s
piral.jar:/usr/local/java/jars/tal.jar:/usr/local/java/jars/fsl.jar

     Note that's all one huge line as a setenv in your .login file or an export in your .profile file.

 2.  Copy .fisproperties to your home directory with your site's setup
     information.

 3.  Run
     java GlobalWorkbench   or
     java GlobalDesktop
     Applications that are successfully found will be active (not grayed out) in the
     GlobalWorkbench.


Help System:

Fiswidgets applications have an HTML-based help system.  Each application
has one or more html documentation pages.  Users specify a browser
application and a document directory in their .fisproperties file.  When
they select the HELP menu item from a Fiswidget application, the application
will spawn the designated browser and load that application's help page
from the document directory.

Site administrator setup:
-- Make a standard Fiswidget document directory, eg fiswidgets-2.3/doc
-- Copy the help pages for all Fiswidget applications that you install 
   into the Fiswidget document directory.  
-- The Fiswidget distribution includes several standard auxiliary html 
   help files:
   localjavasetup.html
   fismenubar.html
   fistoolbar.html
   fisoutputwindow.html
   fistemplate.html
   Standard Fiswidget application html help docs will link to these
   auxiliary docs, so they should be in the standard Fiswidget docs directory.
-- The localjavasetup.html file should be edited to contain instructions
   for running Java on the local machine.
-- The fisproperties.default file should be edited to contain reasonable
   defaults for your site.

End-user setup:
-- Make sure a .fisproperties is installed in your home directory.
-- Make sure the following properties are defined in your .fisproperties file:
   BROWSER=<path to browser, eg /usr/local/bin/netscape>
   FISDOC_PATH=<FisWidgets doc dir, eg /usr/local/fiswidgets-2.3/doc>s
   paths for the bin directories for each application package you use, e.g. AFNI_PATH


Questions and Comments should be sent to:

fissell+@pitt.edu