Skip to content

Installation

Omar Moreno edited this page Jul 10, 2015 · 5 revisions

Requirements

In order to build the project, the following build tools are required:

The project has the following dependencies:

Recommended Packages

In order the build the documentation, the following package is also required:

Installation

Getting the Source Code
Getting a Tagged Release

Unless you are an active developer on the project, it is best to use a tagged release. A release can be downloaded from the projects release page. The project can be downloaded as a zip file or tag.gz file.

Alternatively, a release can be downloaded and untarred by issuing the following commands from a terminal

wget https://github.com/omar-moreno/hps-dst/archive/v0.7.tar.gz
tar zxvf v0.7.tar.gz
cd hps-dst-0.7

Once downloaded, the package can be built in the usual way.

Cloning the Repository from GitHub

The project is stored in a public github repository. The code can be "cloned" i.e. copied to a users local machine by issuing the following commands from a terminal

cd /path/to/workdir
git clone https://github.com/omar-moreno/hps-dst.git

A github account is not required to clone the source code.

Building the Project

Before building the project, the following environmental variables need to be set:

ROOTSYS=/path/to/root
GBL_DIR=/path/to/gbl/cpp
LCIO=/path/to/lcio

The project can then be built as follows:

cd hps-dst
mkdir build; cd build
cmake ../
make

This will create the binaries (in the build/bin directory) along with the shared library HpsEvent.so (in the build/lib directory) which contains the ROOT dictionary and HpsEvent API.

If Doxygen is installed, the API documentation can be generated as follows:

make doc

This will generate both LaTex and html documentation in the directory hps-dst/doc.