Menu ▾ ▴

Galago Installation

David Fisher Jae Hyun Lemur Project

Introduction

Installing Galago

Binary distribution

1. Download

Download the bin.tar.gz file for the version of galago you wish to install, eg, for version 3.14159, the url is https://sourceforge.net/projects/lemur/files/lemur/galago-3.14159/. Browse the parent directory of that link, https://sourceforge.net/projects/lemur/files/lemur/, for newer galago versions.

2. Unpack

Extract the tar file to a location of your choice, eg.

$ cd Development
$ tar xzf galago-3.14159.tar.gz

3. Run

As described below, using the following path:

$ galago-3.14159/bin/galago

Source distrbution

1. Dependencies

Java 8 or newer

Probably already installed on your machine,
but if not: http://www.java.com/

Maven 3.0 or newer

Available for most operating systems. This package can be obtained from: http://maven.apache.org/

Mercurial

Available for most operating systems on: http://mercurial.selenic.com/

2. Obtaining the source code

2.A Using Mercurial

You can download the recent version of source code using Mercurial. The source address of Galago is as follows:

https://sourceforge.net/p/lemur/galago/ci/default/tree/

It should look something like:

$ hg clone http://hg.code.sf.net/p/lemur/galago lemur-galago

2.B TAR file

In order to get the stable version of source code, please download the TAR file in FILE section. Then, decompress it as follows:

$ tar -xzvf galago-3.6.tag.gz

3. Compiling

NOTE: Be sure that the JAVA_HOME environment variable is set to the location of your Java JDK.

Assuming you have installed mvn and checked out the most recent version of galago. Within a terminal, go to the galago directory and run the commands:

$ ./scripts/installlib.sh
$ mvn -DskipTests=true install

After galago has you should see something similar to:

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] 
[INFO] galago ............................................ SUCCESS [0.713s]
[INFO] tupleflow-typebuilder ............................. SUCCESS [5.554s]
[INFO] tupleflow ......................................... SUCCESS [5.216s]
[INFO] core .............................................. SUCCESS [15.686s]
[INFO] contrib ........................................... SUCCESS [7.118s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 34.494s
[INFO] Finished at: Wed Jun 12 15:17:12 EDT 2013
[INFO] Final Memory: 58M/453M
[INFO] ------------------------------------------------------------------------

This output indicates success.

Or, you can use one of the following IDEs:

Note
* For the first build, do a full mvn package or mvn install. A basic compile will not succeed due to missing dependencies.
* In the event that the Maven build fails due to a dependency problem, one can manually install the dependency into the local Maven repository. Below is an example installing Apache commons-math jar file:
mvn install:install-file -DgroupID=org.apache.commons -DartifactId=commons-math3 -Dversion=3.5 -Dpackaging=jar -Dfile=/downloads/commons-math3-3.5/commons-math3-3.5.jar
* After the initial package or install is competed, one can compile any specified module.

4. Running the Galago application

You can now set permissions and run the Galago application:

$ chmod +x core/target/appassembler/bin/galago
$ core/target/appassembler/bin/galago

You should see the output:

:::sh

Type 'galago help <command>' to get more help about any command.

    Popular commands:
       build
       search
       batch-search

    All commands:
       batch-search
       build
       build-entity-corpus
       build-special
       build-topdocs
       build-window
       build-word-dates
       chain-jobs
       doc
       doc-id
       doc-name
       doccount
       dump-connection
       dump-corpus
       dump-index
       dump-index-manifest
       dump-key-value
       dump-keys
       dump-modifier
       dump-name-length
       dump-term-stats
       eval
       harvest-links
       help
       make-corpus
       merge-index
       overwrite-manifest
       pagerank
       search
       stats
       stemmer-conflation
       subcollection
       transform
       xcount

It is possible to copy the galago executable to another location. However, within the galago executable file you will need to modify the $BASEDIR variable to point to the appassembler directory. For example:

BASEDIR:/full/path/to/galago/core/target/appassembler/

5. Setting up Galago for development

Create the Eclipse/IntelliJ project and classpath files using Maven.

For Eclipse:

$ mvn -DdownloadSources=true eclipse:eclipse

via http://maven.apache.org/plugins/maven-eclipse-plugin/usage.html