1) INTRODUCTION ***********************

Logol program requires following structure:

-- install directory
      |
      -- LogolExec.sh : main execution program
      |
      |----- lib   : contains JAR libraries and log property file
      |
      |----- prolog : contains templates required for prolog generation as well as shells used during program execution
      |
      |----- Doc (optional) : Javadoc and prolog documentation
      |
      |----- tools : contains user defined specific cost function programs

2) INSTALLATION: **************************
The software requires Cassiopee Ruby gem or VMatch for suffix array searches. VMatch is an external software with its own license:
http://www.vmatch.de/ (S. Kurtz).

gawk is also required on the system (http://www.gnu.org/software/gawk/)

If software has been manually installed :
Uncompress the package in a directory.
- edit prolog/logol.properties and update dir.result and workingDir. workingDir is a temporary directory used for file creation and result storage.
- in LogolMultiExec.sh, update path for LD_LIBRARY_PATH to reflect path to DRM .so library (for sge)
- if usig vmatch and suffix search tool is not in path for user running queries, edit prolog/suffixSearch.sh and set path to tool (vmatch), and suffix.path in prolog.properties


Properties (prolog/logol.properties) can be modified depending on requirements. See documentation for further info or edit the file.

In case of cluster usage:
Edit prolog/mail.tpl to set up the mail template sent at the end of the jobs.

Nota Bene:
Compilation of prolog program if binary is not available: (requires Sicstus 4.x or swi-prolog)
Go in prolog directory, sicstus binary must be in PATH
>sicstus -i
>>compile(logol).
>>save_program('logol.sav').
>>halt.

>spld --main=user logolMain.c --static --resources=system,random -o logol.exe
>spld --main=user preanalyse.c --static --resources=system,random -o preanalyse.exe

For swi-prolog, read prolog/SWI-README

3) AUTOTEST ******************************

Go to install path and execute logolTest.sh without parameter. All tests should pass.

4) EXECUTION: *****************************

Execute LogolExec.sh (1 sequence) or LogolMultiexec.sh (for banks) with appropriate parameters (see shell file)


5) Documentation generation

Go in tools directory and run generate-doc.sh. SWI-Prolog and TexLive are required.
PDF docs will be generated in Doc.

For grammar documentation, go in Doc/grammar and run generate.sh. Programs needs antlr-works and tex4ht.
It will produce html document with each grammar rule.