README.TXT for COREX version 0.3a Januari 20 2002 Release 3: ---------- This release of the COREX software tries to integrate Corpus browsing on the basis of meta data with the tools already available in the last release. You may find that most of the possible meta data items have not been filled in, unfortunately most of the meta data was not yet available at the time of this release. This will hopefully be remedied at the next or intermediate release. For those of you curious for the meta data vocabulary used we refer to the ISLE Meta data Initiative at http://www.mpi.nl/ISLE. Release 3a: ----------- Release 3a is what we call an intermediate release. It fixes a few bugs (see our web site at http://www.mpi.nl/COREX) and adds some functionality: - There is now also a "CD list" metadata hierarchy that allows you to select all sessions whereof the audio files are on one particular CD. - COREX viewer now works without ".tag" files. - access to zipped ".pri", ".tag" and "skp" transcription files is now transparent to the user. - COREX viewer allows segment synchronization with units smaller than the utterance unit (if provided). - The connection to Praat now depends directly on the "sendpraat" programme (see the Praat documentation). This has the advantage that it is available for all the supported platforms. Though only the windows version is provided with this release. For other platforms the user has to provide the "sendpraat" programme. - The user can configure COREX such that local progammes can be invoked from COREX to work on the transcription and audio files. For the MPI COREX team: Daan Broeder, Max-Planck Institute for Psycholinguistics --------------------------------------------------------------------------- --------------------------------------------------------------------------- INSTALLATION: This is version 3a of the COREX exploitation software for the CGN corpus release 4. This software was tested on Win2000, Win/NT, WIN98, Sun Solaris (Sparc) and Linux. 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 500 MB free disk space for the corex programme 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 CD drive free for loading the CDs with audio files. This is far less than the last COREX release demanded. This is made possible by now compressing almost all transcription files. The COREX software will work with both compressed and uncompressed transcription files. The special ".sea" and ".syn" files should remain uncompressed!!! To install for Windows platforms: - You can throw away your old COREX installation once you have successfully installed this one! - Run the file install This will create a directory C:\COREX3a by default and copy all necessary files to this directory. If you want to install the software in another directory, for instance in d:\MYDIR, type: install-win.bat D:\MYDIR The install script will also create a bat file "corex.bat". This bat file starts up the corex programme. - Create a desktop icon that points to the file C:\COREX\corex.bat if you like. (Note) Installing on Windows98 might produce an error at the end of the procedure that can be ignored. The programme has still been installed correctly. To install for UNIX platforms (only tested on Linux & Solaris): - Run the install-ux.pl perl script with as argument the desired installation directory. For instance to install in /usr/local perl install-ux.pl /usr/local/ The install script will create a command file "corex" that when executed will start up the COREX programme. It is expected that both java and perl executables are in your path!!! Some jars will be copied to the installation directory. However they might not be compatible with jour version of java, in that case you will have to experiment a bit with other versions! Linux configuration: SuSE-Linux 7.1 Java 1.3.0_2 Perl 5.6.0 xerces 1.4.2 jmf 2.1 Sparc Solaris configuration: SunOS 5.8 Java 1.3.1 Perl 5.005 xerces 1.4.2 jmf 2.1 To install for MacOS X We have not yet tested COREX on MacOS X but there is statement about the possibilities on our web site http://www.mpi.nl/COREX REQUIRED SOFTWARE: WINDOWS: For the windows platforms all software is included and will be installed. Extensions programmes such as Praat and Portray that can be used by COREX are not included. UNIX: For the UNIX platforms. You need to supply Java, JMF, Perl. For a list with information what versions are required see our web site http://www.mpi.nl/COREX. For the connection to Praat you need to obtain a copy of the "sendpraat" programme for your particular platform and put it in your path or in the directory where you installed COREX. If you want to run portray yo need also to provide the Tcl/Tk interpreter and put it in your path or in the directory where you installed COREX. REQUIRED HARDWARE: A pentium II 400 with 128 Mb is the very least you should have. You may try less powerful platforms but be prepared to be patient. AVAILABLE EXTENSIONS Praat: Using the COREX programme together with the "Praat" programme imposes more speed and memory requirements. Be sure to keep the list of data objects within Praat to a minimum. Portray: Using the COREX programme together with the "Portray" (see the documentation on the CGN annotation CD's) allows to view the CGN syntax annotation files. You need to copy the "portray.tcl" and "taglist.tcl" files into the COREX installation directory. KNOWN BUGS: 0.1.0.0 The "OR" function in the search panel does not work correctly, it has been removed from the latest version. USER MANUAL: There is a (short) user manual: corexman.doc, updates will be placed on http://www.mpi.nl/COREX FURTHER INFORMATION: For the latest new on "known bugs", "installation problems", "software updates" see the web site: http://www.mpi.nl/COREX BUGREPORTS: Reports on bugs not mentioned here or at http://www.mpi.nl/COREX can be sent to: cgn@let.kun.nl but be sure to write "COREX" in the subject field RIGHTS & RESTRICTIONS & GUARANTEES: This software version is for use with CGN annotation & audio data. All other use is unsupported. All commercial use is prohibited. This version is delivered as such and no claims are made concerning the functionality of the software except that we will try to remove bugs and provide a functioning version. Where the term functioning will be defined in consultation with the proper CGN staff. (C) Max Plank Institute for Psycholinguistics Wundtlaan 1 6525 XD Nijmegen