]>
Commit | Line | Data |
---|---|---|
b521659f | 1 | Package: ALICE HLT |
2 | ||
3 | This package implements the ALICE High Level Trigger 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. | |
7 | ||
8 | This packages is maintained by Matthias.Richter@ift.uib.no | |
9 | Comments, bug reports, suggestions welcome! | |
10 | ||
11 | Overview | |
12 | ======== | |
13 | This package provides is a compilation of shared libraries of the ALICE | |
08e73b29 | 14 | HLT project and is intended for stand-alone compilation, i.e. not as part |
15 | of the AliRoot compilation. | |
16 | ||
b521659f | 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 | |
20 | framework) | |
08e73b29 | 21 | |
b521659f | 22 | - SampleLib: The sample library contains examples for component |
23 | implementation and a tutorial. | |
08e73b29 | 24 | |
b521659f | 25 | - TPCLib: The HLT code for the TPC |
26 | ||
08e73b29 | 27 | Currently, the the package is not included to the standard AliRoot |
28 | compilation, but will be part of it. | |
29 | ||
30 | The old stand-alone build system is still available. Check the README | |
31 | file in the doc folder. | |
32 | ||
33 | Requirements | |
34 | ============ | |
35 | The package needs both ROOT and AliRoot. Both must be set up in the | |
36 | usual way (ROOTSYS, ALICE_ROOT, library locations evtl. specified in | |
37 | LD_LIBRARY_PATH, ...). Actually, the BASE and SampleLib modules are | |
38 | not dependend on AliRoot. The TPCLib does. | |
39 | ||
78b557c2 | 40 | To set up a version retrieved from CVS, autoconf 2.57, automake 1.6 |
41 | ,and libtool 1.4 or higher versions are required. Thats the versions | |
42 | which come with the Scientific Linux CERN 3. The same applies if | |
43 | you want to change the Makefiles. | |
44 | ||
45 | If your GNU build tools are too old, ask the maintainers for a distributed | |
46 | package. | |
47 | ||
b521659f | 48 | Setting up a version retrieved from CVS |
49 | ======================================= | |
50 | Skip this section if you have started from the tar ball. | |
51 | ||
52 | A version checked out from CVS requires a few steps to set up the Makefiles | |
53 | and to set some links which are related to the CVS structure at the IFT. | |
54 | Go to the directory and run | |
55 | autoreconf -i -f | |
56 | ||
57 | Then continue with the package configuration described in the 'Installation' | |
58 | section. | |
59 | ||
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 | |
64 | autoreconf -f -i | |
65 | ||
66 | Please notify the authors about bug fixes/corrections/extensions you made if | |
67 | you consider them worth to be merged into the project. | |
68 | ||
69 | Then continue with the package configuration described in the 'Installation' | |
70 | section. | |
71 | ||
72 | Installation | |
73 | ============ | |
bd771eb6 | 74 | NOTE: The Makefiles which are in repository are port of the old build system. |
75 | Now, the Makefile.am templates are valid. | |
76 | ||
b521659f | 77 | Package build relies on the GNU triplet configure, make and make install. |
bd771eb6 | 78 | For historical reasons there are Makefiles around from the old build system. |
79 | In order to avoid messing up the two build strategies, it is recommended to | |
80 | use a separate build directory, e.g. from the top directory do | |
b521659f | 81 | |
82 | mkdir build | |
83 | cd build | |
84 | ../configure | |
85 | make | |
86 | make install | |
87 | ||
08e73b29 | 88 | The default install directories are set to the current directory ($PWD). |
b521659f | 89 | |
90 | To override the default prefix use | |
91 | --prefix=<dir> | |
92 | ||
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 | |
97 | ||
08e73b29 | 98 | Note: You can have several build directories with different configure options, |
99 | but using the same source code. | |
100 | ||
b521659f | 101 | If you need further information on the GNU build system, execute from the |
102 | top directory: | |
103 | ./configure --help | less | |
104 | ||
105 | ||
08e73b29 | 106 | Documentation |
107 | ============= | |
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. | |
111 | ||
b521659f | 112 | Further information |
113 | =================== | |
114 | A wiki with detailed information is set up at | |
115 | http://www.kip.uni-heidelberg.de/wiki/HLT |