INSTALL GUIDE FOR RIVER-PLATE ESSAY GRADER SYSTEM (REGS)
--------------------------------------------------------

This directory is the distribution of version 1.00 of the REGS essay grading system for UNIX.  This version was created in December, 2004.
Please see our web page https://sourceforge.net/projects/essaygrader for more information about REGS.

CONTENTS of this directory:
---------------------------
   training		The directory that contains the training data for REGS
   REGS-website		The web interface of REGS
   3rdParty		The 3rd party libraries and tools used by REGS
   Boundary		The Boundary module
   Gibb_Detect		The Gibberish Detector module
   Rel_Detect		The Irrelevance Detector module
   Fact_Identifier	The Fact Identification module
   Fact_Checker		The Fact Checking module
   Makefile		The makefile for installing REGS modules.
  

SYSTEM REQUIREMENTS: 
--------------------
This software runs on Unix systems.

PREREQUSITES
------------
1. Brill  Tagger
----------------
a. Download from: http://www.cs.jhu.edu/~brill/RBT1_14.tar.Z
b. After download unzip the tar.Z file:
	prompt>gunzip RBT_14.tar.Z
	prompt>tar -xvf RBT_14.tar
	prompt>cd RULE_BASED_TAGGER_V1.14
c. Install:To install the software make the following changes to the Makefile:
	- The first line of the Makefile is
  		#HOMEDIR  = .
		This should be changed to the home directory of the Brill Tagger. Example.
		#HOMEDIR = /path/to/brill_tagger/RULE_BASED_TAGGER_V1_14.
	- In the Makefile the compiler is specified as cc. This should be changed to gcc or left as cc based on the system settings.
	- promtp>make
	
2. WordNet 2.0
---------------
a. Download from: WordNet can be downloaded from the following website.
"http://www.cogsci.princeton.edu/~wn/obtain.shtml". WordNet is downloaded as "WordNet2.0.tar.gz".
b. After download unzip the tar.gz
	prompt>gunzip WordNet2.0.tar.gz
	prompt>tar -xvf WordNet2.0.tar
	prompt>cd WordNet2.0
c. Install: Install as per the instructions provided in the INSTALL file in this directory.

3. SOAPLite
------------
a. Download from: SOAP::Lite is a CPAN module. It can be obtained from the following website
"http://search.cpan.org/~byrne/SOAP-Lite-0.60a". It is downloaded as "SOAP-Lite-0.60a.tar.gz"
b. After download unzip the tar.gz
	 prompt>gunzip SOAP-Lite-0.60a.tar.gz
	 prompt>tar -xvf SOAP-Lite-0.60a.tar
	 prompt>cd SOAP-Lite-0.60a
c. Install:In the above directory run the following commands - 
If root access is available: 
	prompt>perl Makefile.PL
	prompt>make
	prompt>make install	
If root access is not available:
	prompt>perl Makefile.PL PREFIX=/path_to_other_directory/
	prompt>make
	prompt>make install
	 
INSTALLING REGS
---------------
A. Download and unzip:
a. Download the "RIVERPLATE-1.00.tar.gz" to some directory, say, /path/to/regs.
b. After download unzip the tar.gz
prompt>gunzip REGS.tar.gz
prompt>tar -xvf REGS.tar
prompt>cd RIVERPLATE-1.00/EssayGrader
c. This directory is the home directory of REGS. It will be refered to as REGS_HOME in this document.
REGS_HOME = /path/to/regs/RIVERPLATE-1.00/EssayGrader

B. Install
If you have root access run the following commands in REGS_HOME:
prompt>perl Makefile.PL
prompt>make
prompt>make install

In case you do not have root access or to install the software in a different directory run:
prompt>perl Makefile.PL PREFIX=path_to_other_directory
prompt>make
prompt>make install

C. Set configuration parameters
a. Change to directory REGS-website in REGS_HOME. This is the web interface of REGS.
b. Edit the file regs.CONF
c. Set the following configuration parameters:

1. REGS_HOME=/path/to/regs/RIVERPLATE-1.00/EssayGrader
This is the path to the home directory of REGS

2. BRILL_HOME=/path/to/brill_home/RULE_BASED_TAGGER_V1.14
This is the path to the Brill Tagger.

3. CGI_HOME=/path/to/www/cgi-bin
This is the path to the cgi-bin directory.

4. REGS_LIB=/path/to/regs_pms,/path/to/other_required_pms
Note: If you have installed all the REGS modules and other required modules (like WordNet, SOAPLite, Inline etc) in the root you need not specify the path to them. In this case set REGS_LIB to . (dot)
If not then:
- regs_pms is the directory where the REGS modules have been installed.
- other_required_pms is the directory where the Perl modules like WordNet, SOAPLite, Inline etc are installed. These other modules should be installed in some common directory for example, other_required_pms.
If you have installed other_required_pms in the root you need not specify the path to them. In this case, simply moit the part after the comma and the comma while setting REGS_LIB

Example: 
REGS_LIB=/home/tarun/regslibs/lib/perl5/site_perl/5.8.5,/home/tarun/otherlibs/lib/perl5/site_perl/5.8.5
OR
REGS_LIB=/home/tarun/regslibs/lib/perl5/site_perl/5.8.5 (If other required modules are installed in root)

5. GOOGLE_KEY=somekey
This is the key provided by Google so that Google queries can be fired from REGS. You can obtain a key from http://www.google.com/apis/

6. WORKING_DIRECTORY=essaygrader
You need not change this parameter. This is the working directory of REGS.

d. Save and close the .CONF file.

WEB INTERFACE
-------------
As mentioned above, the REGS web interface is in the REGS-website directory in REGS_HOME. After REGS is installed and the regs.CONF file has been modified, copy the REGS-website folder into your www/cgi-bin directory. 

USE REGS
---------
To access the REGS from the web-interface type the following URL in your browser:
'www/path/to/cgi-bin/REGS-website/index.htm '

Currently, 4 test prompts have been provided with REGS. These are in the prompts.txt file in REGS-website directory. You can add your own prompts to this file. A prompt should be on a new line and there should be one prompt per line.