News
Features
The Lemur Toolkit
Indri Search Engine
Lemur Query Log Toolbar
Lemur Wiki
Download
People
Discussion
Archived Forums
Tutorials
Sign Up

 
CMU - Language Technologies Institute
Carnegie Mellon University
CIIR, University of Massachusetts Amherst
University of Massachusetts
 

The Lemur Project is sponsored by the Advanced Research and Development Activity in Information Technology (ARDA) under its Statistical Language Modeling for Information Retrieval Research Program and by the National Science Foundation.


Note: These tutorials are out of date, please see the Lemur Wiki instead.


Lemur Project Tutorials:
Starting Out

Installing & Compiling: Installing & Compiling for Linux


Contents

  1. Unpack the source
  2. Configure the makefiles
  3. Compile Lemur
  4. Install Lemur Library
  5. Installation Troubleshooting

After downloading the Linux Lemur package, use the following steps to install it:

  1. Unpack the source

    On the command line, type in the following commands to unpack the package. This should create a directory named lemur-4.4,.

      > gunzip lemur-4.4.tar.gz
      > tar -xvf lemur-4.4.tar
    	

  2. Configure the makefiles
     

    Go to the directory for lemur-4.4 and run the configuration script configure. This will generate a file named "MakeDefns", which has some customized definitions to be used in makefiles. configure accepts the 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 clustering components. Default is disabled.
    --enable-assert Enable assert statements in the code. Default is disabled.
    --prefix= 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.

    For example, to configure Lemur with the default libraries:

      lemur-4.4>./configure
    		

    Or to configure Lemur with some modules:

      lemur-4.4>./configure --enable-distrib --enable-summarization
    		

  3. Compile Lemur

    With directory lemur-4.4 as the current working directory, type in "make". This will compile the whole Lemur toolkit and link all the Lemur applications.

      lemur-4.4> make
    			

  4. Install Lemur Library

    After compiling Lemur, type in "make install". This will install the Lemur library and include files according to the directory specified by the prefix option of the configure script. If you change the prefix, be sure to enable all of the modules that you wanted to install.

    For example:

      lemur-4.4> ./configure --prefix=/usr0/mydir-for-lemur
      lemur-4.4> make install
    				

    will create /usr0/mydir-for-lemur/lib/liblemur.a and install the header files in /usr0/mydir-for-lemur/include/. The application executables will be all in /usr0/mydir-for-lemur/bin.

    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.

    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.

    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.

    For users who are only interested in using Lemur as a library and application suite, the original source tree (i.e., the lemur-4.4 directory) can be removed after this step.

  5. Installation Troubleshooting
     
    Solutions to many problems with installing Lemur have been posted on the Lemur Forum.
    Also, please note that we have dropped the support for any version of gcc older than 3.2.
     

 


Previous: Installing & Compiling for Windows XP Back to TOC Next: Installing & Compiling for Mac OS X
[Previous: Installing & Compiling for Windows XP] [Back to TOC] [Next: Installing & Compiling for Mac OS X]

 


The Lemur Project The Lemur Project
Last modified: June 21, 2007. 09:14:12 am