*************************************************************
Installation instructions for WSDGate v 0.05 framework for
Word Sense Disambiguation
*************************************************************

** Pre-requisites **
--------------------

1. General Architecture for Text Engineering - GATE, version 3.0 or higher
   (download and install from http://gate.ac.uk/)

2. Ngram Statistics Package - NSP, version 0.73 or higher
   (download and install from http://ngram.sourceforge.net/)

3. NSPGate, the GATE plugin that is a wrapper component over
   NSP - v 0.03 or above, older version of NSPGate is *NOT* supported.
   (download and install from http://nspgate.sourceforge.net/)

4. Waikato Environment for Knowledge Engineering - WEKA
   (download and install from http://www.cs.waikato.ac.nz/ml/weka/)

5. Java Runtime Environment - JRE (1.4.2 recommended, newer versions
   might cause problems with WEKA and GATE calls from WSDGate)
   (download and install from http://java.sun.com/j2se/1.4.2/download.html)

Note that the INSTALL.sh script *DOES NOT* check for valid installations
of the above software.

** Installation **
------------------

1. Extract the wsdgate-v0.05.tar.gz file using the following command, on Unix
   like system:-

   gzip -cd wsdgate-v0.01.tar.gz | tar xvf -

   For Windows, use Winzip for extracting the contents of this file.

2. Change to the extracted directory in a command prompt as:-

   $ cd wsdgate-v0.05

3. For Unix like systems, run the script INSTALL.sh with the full path to the 
   GATE installation as the only command line parameter. This will copy the 
   required files to the GATE installation. For example:

   $ ./INSTALL.sh /home/johnsmith/programs/GATE-3.1

   ==========================================================================
   NOTE:
   
   The GATE home directory is the one that contains the following directories
   related to GATE:

        bin/
        build/
        doc/
        lib/
        plugins/
        Uninstall_GATE-3.1/
        <..and other platform specific files>

   It is the base directory that was provided to the GATE installer. By
   default it is USER_HOME_DIR/GATE-3.1 on Unix based systems.
   e.g. /home/johnsmith/GATE-3.1

   For a superuser, it would normally be /root/GATE-3.1

   This can be customized during the GATE install to any valid directory
   location - e.g. /usr/local/bin - in which case no directory by the name
   GATE-3.1 would be generated. All the above GATE related directories will be 
   located inside /usr/local/bin

   On a Windows machine, the default location would be
   C:\Program Files\GATE-3.1

   This is again customizable to any valid location e.g. C:\GATE etc.
   ==========================================================================

   For Windows, use the INSTALL.bat script instead of INSTALL.sh

   After successful completion of either of the INSTALL scripts, the following
   message should be displayed (after a few other intermediate messages):

   "WSDGate successfully installed."

   This completes the installation of WSDGate as a Processing Resource
   for GATE. 
   
4. There are a few helper utilities (Perl scripts) shipped with WSDGate which 
   enable configuration of batch mode experiments and extraction of a summary
   of results from several WSDGate experiments. These are located in the
   wsdgate-v0.05/bin directory - mkconfig.pl and summarystats.pl.

   Copy these to the desired destination directory and include that directory
   in your PATH (if not already included) to enable execution of these scripts
   without having to specify their fully qualified path.


** Using WSD GATE **
--------------------

Refer to the USAGE document for usage.


** Copyright Notice **
----------------------

Copyright (C) 2005-06, 

Mahesh Joshi
University of Minnesota, Duluth

Ted Pedersen
University of Minnesota, Duluth

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.