Developers Distribution

This page is under review

The following are the steps that developers have to follow to download EOP and contribute to the code. A prerequisite for this is to have your GitHub account and local git set up previously.

1. Forking the Excitement Open Platform repository
   From the following EOP web page click the fork button. It will create a copy (your own copy) of the EOP repository in GitHub.

https://github.com/hltfbk/Excitement-Open-Platform

2. Cloning your fork
   By the following instructions you will make a copy of your fork and download the code on your local computer.

1. mkdir excitement_open_platform-git
2. cd excitement_open_platform-git
3. git clone git@github.com:user_name/Excitement-Open-Platform.git

where user_name is developer's user name on GitHub.

3. Configuring remotes
   When a repository is cloned, it has a default remote called origin that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you need to add another remote named upstream:

git remote add upstream git@github.com:hltfbk/Excitement-Open-Platform.git

4. Getting changes and merging
   If the original repository you forked your project from gets updated, you can add updates to your fork by the following code:

1. git fetch upstream (Getting changes from the original repo)
2. git merge upstream/master (Merges changes fetched into your working files)

5. Pushing commits to your remote repository stored on GitHub:

git push origin master

6. Contributing to the project
   When you want to contribute to the original fork (i.e. EOP repository), you have to send to the administrators a pull request (click on the Pull request button available from the GitHub web page).

Configuration Files, Models and Resources

Resources like WordNet and Wikipedia as well as the configuration files of the platform, the pre-trained models created by training the platform on the data sets and the data sets themselves are distributed in a separate archive file. The archive contains internal/external libraries and resources whose licence is compatible with General Public License (GPL) version 3. Libraries and resources with GPL 3.0 incompatible licenses have to be downloaded and installed separately from their own web sites. The file containing the resources can be downloaded from:

http://hlt-services4.fbk.eu:8080/artifactory/repo/eu/excitementproject/
eop-resources/{_version_}.tar/eop-resources-{version}.tar.gz

where version is the EOP release version the resources file is referring to. For example this is the link to download the EOP resources file in case EOP release 1.1.0 is used:

http://hlt-services4.fbk.eu:8080/artifactory/repo/eu/excitementproject/
eop-resources/1.1.0.tar/eop-resources-1.1.0.tar.gz

A specific EOP distribution should always be used with a correspondent version of the file of the resources. For example if EOP release 1.1.0 is installed, eop-resources-1.1.0.tar.gz has to be used with. Using a combination of different version for EOP and the file of the resources could produce errors or unexpected results.