Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 3.31 KB

INSTALLATION.md

File metadata and controls

92 lines (69 loc) · 3.31 KB
Raw

Prerequisite:

How to use the software

Using Saul as dependency

If you want to use Saul in your project, should first add it as your dependency. Note that this is the recommended way of using it; if you don't use any dependency management system, you can use compile it directly (next section). Here are examples of how it is done in different dependency managment frameworks. For each sample code, replace VERSION with the latest Saul version number.

  • Maven
<repositories>
    <repository>
        <id>CogcompSoftware</id>
        <name>CogcompSoftware</name>
        <url>http://cogcomp.cs.illinois.edu/m2repo/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>edu.illinois.cs.cogcomp</groupId>
        <artifactId>saul</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>
  • SBT
resolvers += "CogcompSoftware" at "http://cogcomp.cs.illinois.edu/m2repo/"
libraryDependencies += "edu.illinois.cs.cogcomp" % "saul_2.11" % "VERSION"
  • Gradle
compile 'edu.illinois.cs.cogcomp:saul_2.11:VERSION'

Compiling Saul

Usually you need this options if you are developing using Saul, or you want to run the examples.

First, run sbt.

  • projects will show the names of the existing module names.
    • project saulCore will take you inside the core package.
    • project saulExamples will take you inside the examples package.
    • project saulWebapp will take you inside the webapp package. Then type run to start the server. Type localhost:9000 in browser address bar to see the webapp.
  • Inside each project you can compile it, or run it.
  • To fix the formatting problems, run format

Compiling Saul on Windows

To run Saul on Windows installations, make sure that the Java Development Kit (JDK) and the Simple Build Tool (sbt) are installed and available on the PATH.

Also you will have to set the environment variable

set JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF8

Installing Solvers for Inference

Saul uses the the solvers included in illinois-inference for inference. For more details and instructions on how to install these libraries, visit the details of this library.

Installing Gurobi

One of the possible solvers Saul uses, is the Gurobi solver for inference. If you want to use this solver, it has to be installed prior to compilation. To download and install Gurobi visit Gurobi Website

Make sure to include Gurobi in your PATH and LD_LIBRARY variables

export GUROBI_HOME="PATH-TO-GUROBI/linux64"
export PATH="${PATH}:${GUROBI_HOME}/bin"
export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:${GUROBI_HOME}/lib"

Developing and Contributing to Saul

You can use Saul in any integrated development environment (IDE) appropriate for Scala/Java. We suggest using IntelliJ IDEA.

If you are interested in contributing to the Saul project, either by your ideas or codes, you are welcome to create pull requests here.