Changing name of libRAW into libRAWData
[u/mrichter/AliRoot.git] / HLT / doc / README
CommitLineData
3e87ef69 1#
2#$Id$
3#
4
5ALICE High Level Trigger
6-------------------------
7
8After checking out the code, you should see the following
9in the toplevel directory:
10
11bin ............ small scripts to set env or to compile
12exa ............ sample macros showing how to use the code
13kalman ......... (not usable at the moment)
14Makefile.conf .. checks environment for ALIHLT_* variables
15misc ........... lib AliL3Misc (different helper classes)
16sim ............ (not usable at the moment)
17trigger ........ (not usable at the moment)
18comp ........... lib AliL3Comp (compression and deconvolution)
19doc ............ hopefully contains information
20hough .......... lib AliL3Hough (different hough transforms)
21Makefile ....... main makefile (use make libs to compile all libs)
22Makefile.rules . most of the rules for all libs
23programs ....... sample programs showing how to use the code
24src ............ main lib AliL3Src (transformer, tracker and clusterer)
25
26The compilation is controlled by the following variables:
27
28$ALIHLT_USEPACKAGE --> HLT package to compile
29 = ALIROOT (to use galice root files)
30 = ROOT (to use root features)
31 = STANDALONE (to be independant of root)
32
33$ALIHLT_BASEDIR --> base directory, e.g. $HOME/work/hlt
34$ALIHLT_TOPDIR --> directory of top makefile, e.g. $ALIHLT_BASEDIR/code
35$ALIHLT_LIBDIR --> directory where libs will be placed,
36 e.g. $ALIHLT_TOPDIR/lib_$ALIHLT_USEPACKAGE
37
38$ALIHLT_MLUCDIR --> directory of MLUC include and lib sub-directories,
39 e.g. switch of by setting ALIHLT_NOLOGGING="true"
40
41Compiliation flags:
b2a02bce 42$ALIHLT_USENEWIO (false) --> switch to NEWIO
0bd0c1ef 43$ALIHLT_ROWHOUGH (false) --> use row hough transformer
3e87ef69 44$ALIHLT_DOMC (true) --> store Monte Carlo ids (for ALIROOT package)
0bd0c1ef 45$ALIHLT_NOLOGGING (false) --> use HLT logger classes (requires MLUC lib)
3e87ef69 46$ALIHLT_ALIDETECT (true) --> detect ALIROOT version using cvs
47
48!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
49! !
50! Have a look at bin/sethlt_cern.[c]sh !
51! for a sample configuration script. !
52! !
53! After setting the environment, !
54! do `make libs` in $ALIHLT_TOPDIR !
55! to compile the shared HLT libs. !
56! !
57!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
58
59Note, using ROOT THtml class, you can generate html
60documentation (see http://root.cern.ch for an HOWTO).
61
62----------------------------------------------------
63Further Information:
64http://web.kip.uni-heidelberg.de/Hardwinf/L3/
65http://www.ikf.physik.uni-frankfurt.de/~loizides/
66http://www.fi.uib.no/~vestbo/
67----------------------------------------------------
68C. Loizides, loizides@ikf.uni-frankfurt.de