INSTALLATION GUIDE FOR COREX ---------------------------- 0. INTRO This is version 6 of the COREX exploitation software for the CGN corpus. This software was tested on Win2000, Win/NT, WINXP, Sun Solaris (Sparc), Linux and MacOSX. For Windows platforms the installation script copies a complete JAVA environment to the local computer in order to be independent from and avoid version mismatches with local JAVA installations. You need to have about 2 GB free disk space for the COREX program environment and all the CGN annotation files that are also installed by this install script. The annotation files need to be installed on your computer to leave the DVD drive free for loading the CDs with audio files. You do not need to remove any older COREX releases if you have enough disk space available. This release should be installed (and does so by default) in its own directory. 1. REQUIREMENTS. Supported Platforms: COREX runs on the following platforms: Windows NT Windows 2000 Windows XP SPARC Solaris Mac OS X Linux (probably most other Unix flavors) Hardware: Disk Space: 1.9 GB of disk space. Memory: At the very least 128 MB of internal memory. Processor: > Pentium III 1 GHz Software: On the Windows platforms COREX will install its own Java and Perl versions. For the UNIX variants (Mac OS X included) you will need to provide your own versions of Java (version 1.4 or higher) and Perl (version 5.6.1 or higher) and adapt your path so that these programs can be found. 2. INSTALLATION PROCEDURE. Windows: Run the "install.bat" file by either typing this name in a command prompt window or clicking its icon in the explorer. You will be asked a number of questions: 1) The name of the install directory. This directory will be created and filled with programs and data. Default is C:\COREX6. 2) The name of your DVD drive. Usually the default name offered is the correct one since that name is the one you are installing from. COREX needs to know it to be able to find the audio files you will be providing by means of DVDs with audio files. 3) The amount of memory COREX can use. The default (128MB) is the absolute minimum. If you have more memory in your machine available please specify an amount somewhat less than the total amount available e.g. 200MB if you have 256MB available. Please note that you should enter the number only (e.g. do not type 200MB, but 200). When done you will be shown your choices again, and you may continue or cancel the installation. Unix, Linux, MacOS X: Run the "install.sh" script by either typing this name in a terminal window or typing "sh install.sh". You will be asked a number of questions: 1) The name of the install directory. This directory will be created and filled with programs and data. Default is /home/user/COREX6. 2) The name of your DVD drive. Usually the default name offered is the correct one since that name is the one you are installing from. COREX needs to know it to be able to find the audio files you will be providing by means of DVDs with audio files. 3) The amount of memory COREX can use. The default (128MB) is the absolute minimum. If you have more memory in your machine available please specify an amount somewhat less than the total amount available e.g. 200MB if you have 256MB available. Please note that you should enter the number only (e.g. do not type 200MB, but 200). When done you will be shown your choices again, and you may continue or cancel the installation. After the installation you will find that in the installation directory the following directory structure has been created. /COREX6/data /corex/scripts /corex/doc /... /... 1. The COREX6/data directory contains all the annotation data that COREX needs. 2. The COREX6/corex/doc contains the documentation: corex manual, known- bug list, bug reporting etc. 3. The COREX6/corex/scripts directory contains scripts and bat files to startup COREX. The files are: Windows: Use the "corex.bat" file to start-up corex. Create a link from your desktop to this file for easy access. Moving this file to another directory will not work. Unix: Use the "corex.sh" file. Start-up COREX by typing "corex.sh" or "sh corex.sh". You can make a link to this file for easy access. 3. EXTERNAL PROGRAMS COREX can work together with the Praat program to have Praat display a segment of speech. For this it uses a small communication program "sendpraat". For windows the "sendpraat.exe" program will be installed together with COREX. For other platforms you will need to install it yourself in the corex/tools sub directory of the COREX installation dir. For further information on the "sendpraat" program see the Praat website http://www.praat.org/. It has been tested with Praat version 4.1.28 4. MISCELANEOUS INSTALLATION INFO Normally you should not need the information from this section and the deafult installation parameters. Parameters you specified during the installation script are correct. Sometimes it may be necessary to change the way COREX works. You can do that by editing the COREX startup files "corex.bat" or "corex.sh" Looking in the "corex.bat" file you will see: echo "Starting Corex" set BINDIR=D:\COREX6\corex set DATADIR=D:\COREX6\data set AUDIODIR=E:\ set MSIZE=128M set JAVA_HOME=..\java set PATH=..\perl\5.8.0\bin\MSWin32-x86-perlio;..\tools;%PATH% set CLASSPATH=..\jars\batik-svggen.jar;..\jars\log4j__V1.2.6.jar;..\ja .... .... ... By changing the value of the MSIZE parameter you can increase the amount of memory COREX uses. Allowing COREX to use more memory results in improved performance. However, please specify less than the actual amount of RAM your computer has. If you have e.g. 512MB RAM, you could specify 400M. By changing the value of the AUDIODIR parameter you can direct COREX to search the audio files from a non-standard place. This is something you may want when there is a (shared) disk available where all the audio files have been copied to. Unix users will find that the "corex.sh" script looks similar and can be modified with the same results. ------------------------------------------------------------------------- For problems & bugs with COREX see the file: /corex/doc/bugs.txt -------------------------------------------------------------------------