HLT/doc/README

   1 #
   2 #$Id$
   3 #
   4
   5 ALICE High Level Trigger
   6 -------------------------
   7
   8 After checking out the code, you should see the following
   9 in the toplevel directory:
  10
  11 bin ............ small scripts to set env or to compile
  12 exa ............ sample macros showing how to use the code
  13 kalman ......... (not usable at the moment)
  14 Makefile.conf .. checks environment for ALIHLT_* variables
  15 misc ........... lib AliHLTMisc (different helper classes)
  16 sim ............ (not usable at the moment)
  17 trigger ........ (not usable at the moment)
  18 comp ........... lib AliHLTComp (compression and deconvolution)
  19 doc ............ hopefully contains information
  20 hough .......... lib AliHLTHough (different hough transforms)
  21 Makefile ....... main makefile (use make libs to compile all libs)
  22 Makefile.rules . most of the rules for all libs
  23 programs ....... sample programs showing how to use the code
  24 src ............ main lib AliHLTSrc (transformer, tracker and clusterer)
  25
  26 The 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
  41 Compiliation flags:
  42 $ALIHLT_USENEWIO (false)  --> switch to NEWIO
  43 $ALIHLT_ROWHOUGH (false)  --> use row hough transformer
  44 $ALIHLT_DOMC (true)       --> store Monte Carlo ids (for ALIROOT package)
  45 $ALIHLT_NOLOGGING (false) --> use HLT logger classes (requires MLUC lib)
  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
  59 Note, using ROOT THtml class, you can generate html
  60 documentation (see http://root.cern.ch for an HOWTO).
  61
  62 ----------------------------------------------------
  63 Further Information:
  64 http://web.kip.uni-heidelberg.de/Hardwinf/L3/
  65 http://www.ikf.physik.uni-frankfurt.de/~loizides/
  66 http://www.fi.uib.no/~vestbo/
  67 ----------------------------------------------------
  68 C. Loizides, loizides@ikf.uni-frankfurt.de