Installation

We provide different distributions for people who want to experiment with the platform (i.e. users) and for people who want to contribute to the platform (i.e. developers).

Users Distribution

EOP is distributed as a compressed file containing the Java code as well as Maven artifacts when you want to use EOP as a library in your code. 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.

Java Distribution

1. Download the code and save it into your home directory:
   [[Excitement-Open-Platform-{version}.tar.gz | https://github.com/hltfbk/Excitement-Open-Platform/archive/v{version}.tar.gz]]

2. Download the file of the EOP resources and save it into your home directory:
   [[eop-resources-{version}.tar.gz | http://hlt-services4.fbk.eu:8080/artifactory/repo/eu/excitementproject/eop-resources/EOP{version}/resources/eop-resources-{version}.tar.gz]]

3. Download and and save the installation shell script into your home directory:
   [[install.sh | http://hlt-services4.fbk.eu:8080/artifactory/repo/eu/excitementproject/eop-resources/EOP{version}/resources/install.sh]]

4. [Optional for Installing TreeTagger] Download and and save the build.xml ant file into your home directory:
   [[build.xml | http://hlt-services4.fbk.eu:8080/artifactory/repo/eu/excitementproject/eop-resources/EOP{version}/resources/build.xml]]

5. From your home directory, install the EOP by running the script:

> cd ~
> chmod 750 install.sh
### Then for installing the EOP without TreeTagger (i) OR
### both the EOP and TreeTagger (ii).
(i)  > bash ./install.sh {_version_}
(ii) > bash ./install.sh {_version_} treetagger
> export EOP_RESOURCES="/home/user_name/Excitement-Open-Platform-{_version_}/target/EOP-{_version_}/eop-resources-{_version_}/"

Maven Artifacts Distribution

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>{_version_}</version>
  </dependency>
    <dependency>
    <groupId>eu.excitementproject</groupId>
    <artifactId>lap</artifactId>
    <version>{_version_}</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:

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <localRepository>/YOUR_HOME_DIRECTORY/.m2/repository</localRepository>
  <interactiveMode>true</interactiveMode>
  <usePluginRegistry>false</usePluginRegistry>
  <offline>false</offline>
</settings>

Resources like WordNet and Wikipedia as well as the configuration files of the platform and the pre-trained models are distributed in a separated archive file that has to be download and unpack before using it:

• Download the archive file of the resources:
  [[eop-resources-{version}.tar.gz | http://hlt-services4.fbk.eu:8080/artifactory/repo/eu/excitementproject/eop-resources/EOP{version}/resources/eop-resources-{version}.tar.gz]]

• Copy the downloaded file into your home directory, e.g.

   > cp /home/user_name/Downloads/eop-resources-{_version_}.tar.gz ~/

• Extract/unpack it, i.e.

   > cd  ~/
   > tar -xvzf eop-resources-{_version_}.tar.gz
   > export EOP_RESOURCES="/home/user_name/eop-resources-{_version_}.tar.gz

It will create the directory eop-resources-{version} containing all the needed files.

Developers Distribution

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