Development with Terrier 1 Duy Dinh – IRIT – Paul Sabatier University

A step-by-step tutorial to launch Terrier under Eclipse

Institut de Recherche en Informatique de Toulouse – Paul Sabatier University

Duy Dinh

IRIT, Paul Sabatier UniversityDuy.Dinh@irit.fr

Development with Terrier 2 Duy Dinh – IRIT – Paul Sabatier University

DownloadDownload Terrier on the Terrier website Select the appropriate version Check out the following resources:

Terrier forumTerrier documentationTerrier tutorial

Extract Terrier to a directory on your local machine (e.g., /usr/local/Downloads).

Development with Terrier 3 Duy Dinh – IRIT – Paul Sabatier University

Create New Project with TerrierUnder Eclipse, create a new Java project in your workspace (e.g., /usr/local/workspace).Name project as terrier-xx, where ‘xx’ stands for Terrier’s version. Your project will be created in the current workspace (e.g., /usr/local/workspace/terrier-xx)Copy the following folders from the extracted folder to the target project (e.g., …./terrier-xx) in your workspace:

‘src’ : Java source ‘lib’ : referenced library‘etc’ : configuration‘share’ : resource files‘var’ : index, resutls.

Development with Terrier 4 Duy Dinh – IRIT – Paul Sabatier University

Create New Project with TerrierReorganize ‘src’ folder so that the project structure looks like as follows: src/org/terrier/….

Development with Terrier 5 Duy Dinh – IRIT – Paul Sabatier University

Import libraryRight-click on the project name in the ‘Package Explorer’

Select Build path Configure build pathSelect the tab ‘Libraries’ Add External Jar Select all the .jar files in the ‘lib’ folder

Development with Terrier 6 Duy Dinh – IRIT – Paul Sabatier University

Locating the main classGo to the package org.terrier.applications.TrecTerrier.java

Development with Terrier 7 Duy Dinh – IRIT – Paul Sabatier University

Locating the main classDouble click on TrecTerrier.java, click on the main() method and modify it as follows:

Development with Terrier 8 Duy Dinh – IRIT – Paul Sabatier University

Configure TerrierGo to the terrier-xx/etc, copy the terrier.properties.sample to terrier.propertiesModify the following properties

terrier.home=…/terrier-xx/terrier.index.path=…/terrier-xx/var/indexterrier.results=…/terrier-xx/var/resultsetc…

Specify the input of Terrier: Document collection Topics (queries)Qrel filesEtc…

For more details on the properties, please check the properties list of Terrier.

Development with Terrier 9 Duy Dinh – IRIT – Paul Sabatier University

Launch TrecTerrier.javaRight click on the TrecTerrier.javaRun as Run configuration Java application

Development with Terrier 10 Duy Dinh – IRIT – Paul Sabatier University

Specifying virtual argumentsSelect Arguments tab and specifying virtual argumentsAn alternative method to avoid specifying VM arguments is to modify the class ApplicationSetup.java so that Terrier is able to locate the settings in the /etc directory

Development with Terrier 11 Duy Dinh – IRIT – Paul Sabatier University

A step-by-step tutorial to launch Terrier under Eclipse

Institut de Recherche en Informatique de Toulouse – Paul Sabatier University

Duy Dinh

IRIT, Paul Sabatier UniversityDuy.Dinh@irit.fr