Lemur Toolkit Documentation

4.12

Installation

• To configure the lemur toolkit
  1. go to top level lemur directory.
  2. run configure to generate MakeDefns, Makefile, and Makefile.app. configure accepts following arguments:
     • --enable-distrib compiles and installs the distributed retrieval components. Default is disabled.
     • --enable-summarization compiles and installs the summarization components. Default is disabled.
     • --enable-cluster compiles and installs the document clustering components. Default is disabled.
     • --enable-assert Enable assert statements in the code. Default is disabled.
     • --prefix=<install-directory> Specifies the directory for the installed toolkit. Default is /usr/local.
     • --enable-java compiles and installs the swig generated java wrappers. Default is disabled.
     • --enable-php compiles and installs the swig generated php wrappers. Default is disabled.
     • --enable-csharp compiles and installs the swig generated C# wrappers. Default is disabled.
     • --with-javahome=<path> Path to JAVAHOME for compiling the swig generated shared library.
     • --with-php-config=<path> Path to php-config binary. Only required if php-config is not on the path.
     • --with-swig=<path> Path to swig binary. Only required if the wrapper interfaces are changed.
     • --with-site-seed=<hostname> Hostname to use as the seed for building a site search index.

• To make the lemur toolkit library and applications
  1. go to top level lemur directory.
  2. run make (or gmake)

• To clean the lemur toolkit (remove everything but the source)
  1. go to top level lemur directory.
  2. run make clean (or gmake clean)

• To install the lemur toolkit library and applications.
  1. follow the instructions above for configuring and making the toolkit library and applications.
  2. go to top level lemur directory.
  3. run make install (or gmake install)

The lemur include files will be installed in <install-directory>/include, the lemur library will be installed in <install-directory>/lib/liblemur.a, and the applications will be installed in <install-directory>/bin. If you only want the applications, you can use make install-bin. If you only want the library and header files, you can use make install-lib.

If configured with --enable-java, documentation for the Lemur JNI will be installed in <install-directory>/share/lemur/JNIdoc. The file index.html points into the javadoc generated documentation.

For linux and solaris, if configured with --enable-java, the shared library will be installed in <install-directory>/lib/liblemur_jni.so and the java class files will be installed in <install-directory>/share/lemur/lemur.jar and <install-directory>/share/lemur/indri.jar, for the Lemur and Indri APIS. You will need to add <install-directory>/lib to your LD_LIBRARY_PATH and add the appropriate jar file(s) to your CLASSPATH to use the JNI interface.

For OS/X, if configured with --enable-java, the shared library will be installed in <install-directory>/lib/liblemur_jni.jnilib and the java class files will be installed in <install-directory>/share/lemur/lemur.jar and <install-directory>/share/lemur/indri.jar, for the Lemur and Indri APIS. You will need to add <install-directory>/lib to your java.library.path on the java command line, using -Djava.library.path=<install-directory>/lib and add the appropriate jar file(s) to your CLASSPATH to use the JNI interface.

Four additional jar files are installed. RetUI.jar provides a basic document retrieval GUI for interactive queries, using the Indri API. IndexUI.jar provides a basic collection indexing GUI for building an indri repository. LemurRet.jar provides a basic document retrieval GUI for interactive queries using the Lemur API. LemurIndex.jar provides a basic collection indexing GUI for building Lemur indexes. All are installed in <install-directory>/share/lemur and can be run with

java -jar <jarfilename>

If configured with --enable-php, the shared library will be installed in <install-directory>/lib/libindri_php.so. You will need to manually install it in the correct extensions directory for your php configuration. Note that only portions of the Indri API are wrapped for use with PHP.

If configured with --enable-csharp, the shared library will be installed in <install-directory>/lib/liblemur_csharp.so. The C# wrapper classes assembly will be installed in <install-directory>/lib/LemurCsharp.dll This assembly should be referenced by your C# program.

Programming with the lemur toolkit

To build an application using the toolkit library:

1. follow the instructions above for installing the toolkit library.
2. Copy Makefile.app from the top level lemur directory to the directory with your application's source code. Edit the file and fill in values for
   • OBJS -- list of each of the object files needed to build your application.
   • PROG -- name for your application.
3. use make -f Makefile.app to build your application.

Change the toolkit

Modifying the toolkit is not recommended, but individual users may need to customize its behavior.

• To modify an existing file or add a file to an existing directory:
  1. Make the changes
  2. follow the instructions above for making the toolkit library and applications.
  3. follow the instructions above for installing the toolkit library.

• To add a new (library) module to the toolkit:
  1. Add the module subdirectory to lemur, for example "<new-module-dir>".
  2. Put all include files in the subdirectory named "<new-module-dir>/include".
  3. Put all implementation files in the subdirectory named "<new-module-dir>/src".
  4. Add the module directory name to the Makefile variable LIBDIRS and to the MakeDefns variables MODULES and ALLMODULES. New modules should be placed at the front of the lists. Note: If you rerun configure, you will have to make this change again. Advanced users should edit MakeDefns.in to add the module directory name to ALLMODULES and edit configure.ac to add an AC_ARG_ENABLE for the new module (see the distrib entry in configure.ac) and then use autoconf to generate a new configure script.
  5. Copy a Makefile from an existing module directory (e.g, index/src/Makefile) to <new-module-dir>/src, and change the variable MODULE to the name of the new module (<new-module-dir>).

To run lemur applications

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

  
      <parameters>
        <index>/usr0/mydata/index.key</index>
      </parameters>
    

  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_key_index.sh" which is a self-explanatory shell script that will build an index, run several retrieval algorithms with some sample parameter files, and then evaluate the retrieval performance.

---