Skip to content
rzanoli edited this page Mar 6, 2014 · 16 revisions

We provide different distributions for users depending on the fact that they want to get the code as a Compressed Archive File, clone the code from the repository Cloning the code from the GitHub repository or they want to use the EOP Maven Artifacts (i.e. users want to use EOP as a library in their own code). Basically the code in the Compressed Archive and that obtained by cloning the project are two ways to obtain the same code whereas the maven artifacts are stored in the EOP maven repository and can be downloaded by Maven as dependencies. Common to all of the distributions is the necessity to download an additional archive file containing the resources (like WordNet and Wikipedia) and the configuration files needed to use the platform; this archive file can be downloaded from the EOP repository as described below in Configuration Files, Models and Resources.

Differently to users who want to use the platform as it is, people who want to contribute to the platform must use the distributions dedicated to the developers (see the Development Section available from the right menu of page: https://github.com/hltfbk/Excitement-Open-Platform/wiki/).

Compressed Archive

EOP is available as zip and tar.gz archives:

Cloning the code from the GitHub repository

The following procedure lists the steps for cloning the latest release of EOP; in the example we assume that the git tool is already installed on your machine.

> mkdir excitement_open_platform-git
> cd excitement_open_platform-git
> git clone https://github.com/hltfbk/Excitement-Open-Platform/tree/v1.1.1

Maven Artifacts

EOP is also distributed via the EOP maven artifactory repository and the maven artifacts are located there. They include the binary code, the sources code and the javadoc jars. To use EOP in your project specify the following dependencies in the pom.xml file of your project; all transient dependencies are resolved automatically.

<dependencies>
  <dependency>
    <groupId>eu.excitementproject</groupId>
    <artifactId>core</artifactId>
    <version>1.1.1</version>
  </dependency>
  <dependency>
    <groupId>eu.excitementproject</groupId>
    <artifactId>lap</artifactId>
    <version>1.1.1</version>
  </dependency> 
</dependencies>

Repositories exist as a place to collect and store artifacts. Whenever a project has a dependency upon an artifact, Maven will first attempt to use a local copy of the specified artifact. If that artifact does not exist in the local repository, it will then attempt to download from a remote repository. The repository elements within a POM specify those alternate repositories to search. To use EOP this repository has to be put in the pom.xml file of your project to:

<repositories>
  <repository>
    <id>FBK</id>
    <url>http://hlt-services4.fbk.eu:8080/artifactory/repo</url>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
  </repository>
</repositories>

Configuration Files, Models and Resources

Resources like WordNet and Wikipedia as well as the platform Configuration Files, the pre-trained models created by training the platform on some data sets and the data sets themselves are distributed in a separate archive file. EOP can work with a number of different tools (e.g. OpenNLP) and resources. Some of them have licences that are compatible with the EOP one and so they are distributed with EOP whereas others, whose licence in not compatible, have to be downloaded and installed under the terms of their licence by users. A complete list of these tools and resources is available from the EOP Licence page while the archive containing the tools and resources that we are allowed to distribute is available from this link: EOP Resources Zip File v1.1.1

Clone this wiki locally