Lemur Toolkit Documentation

2.0

Installation

• After checking out the toolkit

1. go to directory "lemur"
2. type in "configure", which will generate MakeDefns.

• To make the lemur toolkit

1. go to directory lemur
2. type in "gmake all" or "gmake"

• To clean the lemur toolkit (remove everything but the source)

1. go to directory lemur
2. type in "gmake clean"

Change the toolkit

• To modify an existing file or add a file to an existing directory:

1. Make the changes
2. Go to directory lemur
3. Type in "gmake all"

• To add a new (library) module to the toolkit:

1. Add the module subdirectory to lemur
2. Put all include files in a subdirectory named "include" under the new module directory
3. Put all implementation files in a subdirectory named "src" under the new module directory
4. Add the module directory name to the Makefile in directory lemur or lemurdev.
5. Copy a Makefile from an existing module directory (e.g, index/src/Makefile) to <new-module-dir>/src, and change the first two lines to define this module and its dependent modules.

• To add a new application directory to the toolkit:

1. Add the application subdirectory to lemur
2. Put all include files in a subdirectory named "include" under the new module directory
3. Put all implementation files in a subdirectory named "src" under the new module directory
4. Add the application directory name to the Makefile in directory lemur or lemurdev.
5. Copy a Makefile from an existing application directory (e.g, app/src/Makefile) to <new-application-dir>/src, and change the line that defines the dependent modules.

To run lemur applications

• Create a parameter file with value definitions for all the input variables of an application. Terminate each line with a semicolon. For example,

      index = /usr0/mydata/index.bsc;
    

  Most applications will display a list of required input variables, if you run it with the "--help" option.

• Run the application program without the parameter file as the only argument.

To try the sample data

• Go to the data directory, run "test_basic_index.sh", "test_pos_index.sh", or "test_struct_query.sh", which are self-explained shell scripts that will build an index, run several retrieval algorithms with some sample parameter files, and then evaluate the retrieval performance.

Generated on Mon Sep 30 12:06:04 2002 for LEMUR by 1.2.18