Installation

This software requires Java 8 or higher.

If you plan to use it with Scala, it also needs Scala 2.11 or higher. Scala is often installed as part of sbt, the Scala Build Tool, which one would need to build the project or incorporate it into a different Scala project. sbt will be configured to use a compatible version of Scala automatically.

Beyond that, the bulk of this software is available in compiled jars on Maven Central and in source code at GitHub.

Use with Maven

To use processors with Maven, typically to build a Java project, simply add the dependencies below to your pom.xml file. Replace x.x.x with an actual version number; the latest stable version is 10.0.0 for processors and 0.3.1 for processors-model.

<dependency>
   <groupId>org.clulab</groupId>
   <artifactId>processors_2.12</artifactId>
   <version>x.x.x</version>
</dependency>
<dependency>
   <groupId>org.clulab</groupId>
   <artifactId>processors-model</artifactId>
   <version>y.y.y</version>
</dependency>

Use with sbt

The equivalent sbt dependencies are

libraryDependencies ++= {
  Seq(
    "org.clulab" %% "processors" % "x.x.x",
    "org.clulab" % "processors-model" % "y.y.y"
  )
}

External Binaries

Most processors dependencies are captured in the build.sbt files. However, a few (optional) unit tests also depend on the svm-rank binaries, which should be installed separately. Simply installing the svm-rank binaries to /usr/local/bin (or another generic location in your path) solves the problem.

Installing on Mac OS X via homebrew

On Mac OS X, you can also install these external binaries using brew:

brew tap myedibleenso/nlp
brew install svmlight svmrank

Compiling the Source Code

The source code is an sbt project, so use the usual commands, e.g., sbt compile to compile.