# file AAREADME.text for isip_proto_5.15.tar.gz
# February 08, 2004

Quick Start:

To install the ISIP ASR prototype system, after unpacking use

      configure [--prefix=/<install directory>]
      source ISIP_ENV.sh
      make
      make install
      make test

(Note: if you use the --prefix option, it must contain a leading
"/" and be an absolute path name.)

After you have installed, you can establish the ISIP environment
(or re-establish it in later sessions) by using the source command:

source <install directory>/ISIP_ENV.sh

or
cd <install directory>
source ISIP_ENV.sh

(Note: if you open a new shell, you can re-establish the ISIP
environment by using the source command)

Description:
------------

The Institute for Signal and Information Processing at Mississippi
State University is pleased to provide this version 5.15 update of the
Automatic Speech Recognition Prototype System. This package is under a
public-domain license shown at the bottom of this file.

The primary changes in this release are efficiency improvements in the
baum-welch trainer and the decoder. We have also fixed a couple of
bugs reported by our users.

Prerequisites:
-------------

The base system depends on the GNU C++ compiler, g++, and on the GNU
make program.  You must have at least version 3.1.x of g++, and
version 3.78.x of GNU make for the system to install.  Other versions
may work, but these are the versions we support.  These programs are
available at http://www.gnu.org.

The utilities in the package will not run without perl.  You should
have at least version 5.x.  Perl is available at http://www.perl.com.

The graphical interface to the package requires tcl/tk version 8.x.
Tcl/tk is available from http://dev.scriptics.com.  Note: the executable
name "wish" must be in your path.

The evaluation package requires sclite which can be obtained from NIST
at http://www.nist.gov/speech/tools/index.htm .

The system has been generated on SunOS 5.7 (Solaris 2.7) for x86
hardware, and on Redhat Linux 9.0 for x86 hardware.  It has also been
installed on the cygwin unix-like interface for Windows computers.  It
may also run in other environments.

Hardware requirements.  The minimum hardware we have run the system on
has 128 megabytes of RAM, and processors running at 500 megaHertz.
More RAM and faster processors give better performance.

Details:
--------

First, download the tarfile, unzip it, and extract the files. Users
using cygwin should not use the winzip to extract the files from the
tarfile, instead first unzip and then extract the files. The directory
where these sources are kept can be different from the directory where
the executable programs are installed.

1.  Run configure.  Optionally, you may specify the directory where
    the executables will be installed by using the --prefix option.
    The default install directory is /usr/local/isip_proto/.
    If you type "configure" and the system responds "command not
    found," then type "./configure" instead.  
    ****************************************************************
    If any required modules are not found, you will receive warning 
    messages and will not be allowed to proceed.
    ****************************************************************

    Example:  configure --prefix=/usr/local/isip_proto
    Example:  ./configure --prefix=/usr/local/isip_proto

    NOTE: Some administrators keep both the SunOS make and the GNU
    make on their systems at the same time.  On systems we have seen, GNU
    make was called "gmake," and Sun make was called "make."  To enable
    you to get the correct one, the configure process ends with a comment
    indicating the name of the GNU make command which you should type to
    start the make process.

2.  Run make.  The configure process will tell you which command to type
    to get GNU make.  (Some systems include other makes, but our makefiles
    use features only available in GNU make, so it must be used.)  This
    step insures all header files are in the proper include/ directory 
    and compiles all the programs.

    Example:  make

3.  Run make with the install option.  This time, make will link the
    object modules together and move them to your install directory.

    Example:  make install

4.  Run make test.  This version of the ISIP prototype system comes
    with a verification suite.  If the programs compiled properly,
    they will run and produce a known set of output with the provided
    input data.  If problems occurred somewhere in the installation,
    the test should fail.

    Example:  make test

5.  A shell file ISIP_ENV.sh is created by the installation process and 
    will be placed in your defined installation directory. It contains
    the definition of the environment variables used by the ISIP programs.
    You should always enter "source ISIP_ENV.sh" when you want to run the
    ISIP programs.

    Example:  source /usr/local/isip_proto/ISIP_ENV.sh

Other Options:
--------------

There are other options available to the make program.

1.  Using the make target "clean" will remove the object files and executables
    created in the source directories. it will not affect the installation
    directories.

    Example:  make clean

2.  Using the target "distclean" will remove all the files that make
    clean does, and all the files which were installed by running
    'make install', including the library, binary, include, and
    documentation directories.  It will also erase the temporary files
    that configure created, which will allow you to have a clean
    re-installation by running configure again.  Note that, if the
    base install directory was created during the install process, it
    will not be removed.
    
    Example:  make distclean


Contact Points:
---------------

This package is distributed by the Institute for Signal and Information
Processing (http://www.isip.msstate.edu/) at Mississippi State University
(http://www.msstate.edu/). We have a free help facility available via email
by mailing help@isip.msstate.edu. This service can be used for assistance
in installing and running the system, requests for features, bug reports,
and other comments, complaints, suggestions, etc. Typically, we are able
to reply to your mail within a single business day.

For more extensive documentation on this project and the software
distribution, please visit the web pages:

 http://www.isip.msstate.edu/projects/speech/software/tutorials/prototype
 http://www.isip.msstate.edu/projects/speech/
 http://www.isip.msstate.edu/projects/speech/software/

License:
--------
=-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==
Institute for Signal and Information Processing
Mississippi State University

LICENSE AGREEMENT

This software is distributed without any restrictions.
You may copy, distribute, or modify this software as you see fit.

This package is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantibility and fitness for a particular purpose.
=-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==-==

# end
#
