3 This package implements the ALICE High Level Trigger analysis framework.
4 All contributions are under the terms of the
5 GNU General Public License as published by the Free Software
6 Foundation. Also see files AUTHORS and THANKS.
8 This packages is maintained by Matthias.Richter@ift.uib.no
9 Comments, bug reports, suggestions welcome!
13 This package provides a compilation of shared libraries of the ALICE
14 HLT project and is intended for stand-alone compilation, i.e. not as part
15 of the AliRoot compilation.
17 - BASE: The base library (libHLTbase.so) provides the common interface for HLT
18 processing components, the binding into the ALICE offline project AliRoot
19 and a pure C interface to the HLT on-line framework (Publisher/Subscriber
22 - SampleLib: The sample library contains examples for component
23 implementation and a tutorial.
25 - TPCLib: The HLT code for the TPC
26 - TPCLib/OnlineDisplay: HLT visualization code for the TPC
28 Currently, the the package is not included to the standard AliRoot
29 compilation, but will be part of it.
31 The old stand-alone build system is still available. Check the README
32 file in the doc folder.
36 The package needs both ROOT and AliRoot. Both must be set up in the
37 usual way (ROOTSYS, ALICE_ROOT, library locations evtl. specified in
38 LD_LIBRARY_PATH, ...). Actually, the BASE and SampleLib modules are
39 not dependend on AliRoot. The TPCLib does.
41 To set up a version retrieved from CVS, autoconf 2.57, automake 1.6
42 ,and libtool 1.4 or higher versions are required. Thats the versions
43 which come with the Scientific Linux CERN 3. The same applies if
44 you want to change the Makefiles.
46 If your GNU build tools are too old, ask the maintainers for a distributed
49 Setting up a version retrieved from CVS
50 =======================================
51 Skip this section if you have started from the tar ball.
53 A version checked out from CVS requires a few steps to set up the Makefiles.
54 Go to the directory and run
57 Then continue with the package configuration described in the 'Installation'
60 Modifying a distributed package
61 ===============================
62 If you are going the modify a distributed package you might need to re-make
63 the GNU build system by running
66 Please notify the authors about bug fixes/corrections/extensions you made if
67 you consider them worth to be merged into the project.
69 Then continue with the package configuration described in the 'Installation'
74 NOTE: The Makefiles which are in repository are part of the old build system.
75 Now, the Makefile.am templates are valid.
77 Package build relies on the GNU triplet configure, make and make install.
78 In order to keep the development directory clean, it is recommended to
79 use a separate build directory.
87 You should redirect the output of the make into a file.
88 The default install directories are set to the current directory ($PWD).
90 To override the default prefix use
93 Some important options:
94 --enable-logging # Enable/Disable logging (default enabled)
95 --enable-sample # Compile the sample library
96 --enable-tpc # Compile the TPC library
98 Note: You can have several build directories with different configure options,
99 but using the same source code.
101 If you need further information on the GNU build system, execute from the
103 ./configure --help | less
108 Documentation is generated from the source code at compile time if
109 doxygen is installed on the machine. From the build directory, open
110 doc/html/index.html with a web browser.
114 A wiki with detailed information is set up at
115 http://www.kip.uni-heidelberg.de/wiki/HLT
117 Reporting bugs/Asking for support
118 =================================
119 Please include the following information into your request:
120 - config.log from your build directory
121 - output of the make process. Note: Redirect BOTH the stdout and stderr
122 channel to a log file. Redirection depends on the shell you are using:
123 bash: make 2>&1 | tee make.log
124 csh: make |& tee make.log
125 The 'tee' command just duplicates the output.