Installation Guide

#########################################################################

1. Components
-------------------------------------------------------------------------

After downloading and unpacking the software package, you have the 
following files:

  - install.readme   this file
  - flexi_       Installation program for architecture 
  - install_hts.dat  Default installation configuration
  - flexi_.pac   Software package for architecture 

flexi is an executable. If it does not have the 'x'-flag, set it with
"chmod +x flexi_".

You also have the following directory:
  - example/

In this directory are the configuration files for running HTSview along
with a recommended directory structure and a tutorial (PDF file plus 
example data files).

2. Obtaining the Processor ID of your machine
-------------------------------------------------------------------------

Run "./flexi_ -i" and flexi will give you the Processor ID of the 
machine. You need to send this Processor ID to BioSolve IT in order to obtain
a license key to install and run HTSview. You must include the Processor
ID on the license agreement which you need to send to us before you 
can receive a license key. You may also mail your Processor ID to one of the 
support addresses in advance:

   support@biosolveit.de        or
   HTSview-info@biosolveit.de

3. Editing the install_hts.dat file
-------------------------------------------------------------------------

1. Enter the license keys into either:
   a: the install_hts.dat file after the keyword "@license". Each
   key requires a separate line beginning with the expiration date. You can
   write the name of the machine behind a #-character after the key as a label
   but this is optional.

   @license
        02/01/1998  00000000  KglFyC6067SobikPfdTzqYo # machine 1
        02/01/1998  00000000  KaSGheKrgHaS23drTU99sdS # machine 2

   or b: a separate license file. This is an ascii file that must contain
   one license key per line (there maybe addition comment lines beginning
   with the '#' character). The install_hts.dat file must then have the
   filename of the license file entered on a new line after the keyword
   "@license_files".

   @license_files
   /home/licenses/all_licenses_file.dat
  
2. The second entry in the install_hts.dat file is the root directory starting
   with "@rootdir". All paths specified later in the file are relative to
   this path except those starting with "/" or "./". In the "@directories"
   section, you can define default paths to various data. The "@static_data"
   section contains paths and filenames of the static data files and the
   "@programs" section paths and filenames of executables.

   For a simple installation in the current directory, you can
   write the current path into the definition of the root directory
   and just leave all the rest as it is. You can customize the
   configuration of HTSview later on and individually for
   each user.

4. Installation
-------------------------------------------------------------------------

To start the installation process, type "./flexi_ -p HTSVIEW" 
You must use one of the machines for which a license key is available. 
FlexI converts the flexi_.pac package and moves the files to the 
directories specified in the install_hts.dat. Directories will
be generated if they are not available. You will now have the following
new directories:

  - bin          containing the HTSview and FTrees executables
  - help         containing all the help files for these two programs
                 (including the User Guides)
  - static_data  containing the static data files for these two programs

5. Configuring HTSview
-------------------------------------------------------------------------

The configuration files for HTSview, FTrees and FlexS are in the 
example/ directory. Enter the license keys (or license file names) into
the config_hts.dat, config_ft.dat and config_sp.dat files exactly as 
described in step 2. above for the install_hts.dat file. (If you 
entered the keys in a license file then just enter the path to the 
same license file into  these configuration files.) You should also 
edit the "@rootdir" path as above (make sure it now points to the 
example/ directory) and following entries. (Below this sections come 
flags etc. for altering the behaviour of the HTSview and FTrees programs. 
You may want to change these later on - see the User Guide for more 
details.)

6. A first simple test
-------------------------------------------------------------------------

Go to the example/ directory and type "../bin/htsview". 
After printing a startup message, the program will read the configuration 
file and the static data files and the HTSview main window will appear.