Installing the DST Tools

Preliminaries

The DST maker and HpsEvent API require the following packages before they can be built: 

• The LCIO C++ API
• ROOT data analysis framework
• Generalized Broken Lines 
• CMake > 2.8
• Doxygen (Optional. Used to build the documentation.) 

Getting the Source Code

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 the project is built, the following environment variables need to be set.

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

Then the project should 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 HPS Event API.  

The API documentation can be generated as follows: 

make doc

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