FastJet 3.5.2
Loading...
Searching...
No Matches
INSTALL
1-------------------------------------
2Installation instructions for FastJet
3-------------------------------------
4
5These instructions are for installation from an untarred FastJet release
6tarball. For additional steps needed from a git clone, see below.
7
8FastJet can be configured, built and installed using the standard
9sequence
10
11% ./configure [options]
12% make
13% make check (optional)
14% make install
15
16
17The full list of configuration options can be obtained with ./configure --help.
18Some useful ones include:
19
20 --prefix=<where-you-wish-to-install> (default=/usr/local)
21 specify location where FastJet will be installed
22 The library and plugins will be installed in
23 ${prefix}/lib while the headers will be placed in
24 ${prefix}/include/fastjet
25
26 --disable-static
27 --enable-static disable/enable construction of static libraries
28 (enabled by default)
29
30 --disable-shared
31 --enable-shared disable/enable construction of shared libraries
32 (enabled by default)
33
34 --enable-pyext enable the python interface (default=no)
35
36 --enable-cgal enable use of CGAL libraries, which are needed
37 for the N ln N version of the k_t algorithm and
38 N^{3/2} version of anti-k_t; relevant mainly if you
39 expect to have N>15000.
40
41 --with-cgaldir=directory
42 For CGAL >= 3.4 tells it where to look for CGAL, if
43 it's not in a standard place.
44
45 --with-cgal-boostdir=dir
46 --with-cgal-gmpdir=dir
47 --with-cgal-mpfrdir=dir
48 specifies user-defined locations for CGAL
49 dependencies (Boost, GMP and MPFR)
50
51 --enable-cgal-header-only (default=yes)
52 specifies that one is working with a header-only
53 version of CGAL. Since it defaults to 'yes', using
54 --enable-cgal is sufficient with CGAL v5 or later.
55 Use --disable-cgal-header-only with CGAL v4 or earlier.
56 This will hopefully be auto-detected in a future
57 version of FastJet.
58
59 --with-cgalmakefile=makefile
60 For CGAL <= 3.3.x specify location of CGAL
61 Makefile (which contains info on correct
62 compilation flags when using CGAL). In the
63 absence of this flag, the environment variable
64 $(CGAL_MAKEFILE) will be used to locate the CGAL
65 Makefile. If this is absent too, the default
66 location (/usr/share/cgal/cgal.mk) is used.
67
68 --enable-allcxxplugins (default=no)
69 enable all C++ plugins, but not the Fortran ones
70
71 --enable-allplugins (default=no)
72 enable all plugins, including the Fortran ones
73 (PxCone).
74
75 --enable-siscone (default=yes)
76 enables the SISCone plugin
77
78 --enable-cdfcones (default=yes)
79 enables the CDFJetClu and CDFMidPoint plugins
80
81 --enable-d0runiicone (default=no)
82 enables the D0RunIICone (also known as
83 ILConeAlgorithm within D0)
84
85 --enable-pxcone (default=no)
86 enables the PxCone plugin (note this is in f77,
87 and so you may have to deal with C++/f77
88 compatibility issues)
89
90 etc. many more plugins available: --help option lists
91 them
92
93
94As well as installing the libraries and headers, "make install" also
95installs ${prefix}/bin/fastjet-config; assuming this is in your path,
96then you can compile a program that uses fastjet as follows
97
98% g++ myprog.cc `fastjet-config --cxxflags --libs --plugins` -o myprog
99
100The --plugins option is only needed if you want access to plugins.
101If shared libraries are built, they will be used by default. You can
102still switch to the static libraries by adding the --shared=no option.
103Other examples of the usage of this are given in the Makefile.alt file
104in the example directory.
105
106
107Note on the --enable-foo usage
108------------------------------
109Each --enable-foo option can also be specified using --enable-foo=yes.
110If, instead you want to disable the option, you can use --enable-foo=no
111or --disable-foo.
112
113
114Note for git users
115------------------
116
117If you clone FastJet from the git repository, you first need to set up
118the SISCone submodule
119
120% git submodule init
121% git submodule update
122
123Then you should generate all configuration files. This is done using
124
125% ./autogen.sh [configure options]
126
127or, alternatively,
128
129% autoreconf --install
130% cd plugins/SISCone/siscone; autoreconf --install; cd ../../..
131% ./configure [configure options]
132
133Remarks:
134
135- a version of libtool >= 1.5 is needed. On older version of Mac OSX the
136 GNU libtool should be installed.
137- adding '--force' to the list of autoreconf arguments will overwrite
138 the INSTALL file with the default version
139- using the autogen.sh script automatically runs ./configure
140 (with the specified options)
141- on some systems, config.h from git (and a corresponding file in the SISCone
142 release) may get overwritten. It is usually safe to restore the
143 original git versions with "git checkout config.h".
144
145
146======================================================================
147OLD (NON-AUTOTOOLS) BUILD SYSTEM
148======================================================================
149
150These instructions are obsolete.
151
152------------
153Quick method
154------------
155
156Run the following to build FastJet and its plugins and to test them.
157
158% ./test-static.sh
159
160(NB: this no longer works as of FastJet 2.4, but the files have been
161left in place in case somebody prefers a non-autotools solution and
162wishes to update it.)
163
164------------------
165Longer description
166------------------
167
168To make it possible to have two build systems in parallel, the
169makefiles for the old system are named makefile.static -- you should
170tell make to use them explicitly with the "-f makefile.static" option.
171
172As a first step the user should decide whether or not they want to
173have access to the N ln N algorithms for the kt algorithm, based on
174the Computational Geometry Algorithms Library (CGAL).
175
176If the user does not wish to use it, he or she should ensure that the
177Makefile in the top directory has the line
178
179USE_CGAL = no
180
181Otherwise it should read
182
183USE_CGAL = yes
184
185In that case the user should first download CGAL from
186http://www.cgal.org/ and then compile and install it. Under linux, she
187or he will have to ensure that an environment variable CGAL_MAKEFILE
188points to the Makefile generated by CGAL at install time, containing
189various definitions of locations of include files. CGAL will encourage
190the user to set this variable during the install process.
191
192Then in the src/ directory do
193
194% make -f makefile.static
195% make -f makefile.static install
196
197which places the fastjet library in lib/.
198
199To build the cone jet-finder plugins, you should go to the plugin
200directory and type
201
202% make -f makefile.static
203% make -f makefile.static pxcone
204 // OPTIONAL -- if you want fortran pxcone plugin
205 // to be compiled too -- make sure you also set
206 // G77LIBDIR in the main Makefile
207
208To run the example program cd to the example directory and do
209
210% make -f makefile.static fastjet_example
211% ./fastjet_example < data/single-event.dat
212
213The output (without CGAL) should be
214
215>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
216#--------------------------------------------------------------------------
217# FastJet release 2.3-beta0
218# Written by M. Cacciari, G.P. Salam and G. Soyez
219# http://www.lpthe.jussieu.fr/~salam/fastjet
220#
221# Longitudinally invariant Kt, anti-Kt, and inclusive Cambridge/Aachen
222# clustering using fast geometric algorithms, with area measures and optional
223# external jet-finder plugins.
224# Please cite Phys. Lett. B641 (2006) [hep-ph/0512210] if you use this code.
225#
226# This package uses T.Chan's closest pair algorithm, Proc.13th ACM-SIAM
227# Symp. Discr. Alg, p.472 (2002), S.Fortune's Voronoi algorithm and code .
228#-------------------------------------------------------------------------
229Ran Longitudinally invariant kt algorithm with R = 1 and E scheme recombination
230Strategy adopted by FastJet was N2Tiled
231
232Printing inclusive jets with pt > 5 GeV
233---------------------------------------
234jet # rapidity phi pt n constituents
235 0 -0.86730713 2.90511470 983.38727662 35
236 1 0.22380471 6.04226446 910.28808604 52
237 2 -1.16520657 6.04589034 70.78886044 48
238 3 -2.34731970 1.25431317 10.72317440 18
239 4 -1.19479918 0.80734483 8.29342805 15
240 5 -1.71897064 4.01955399 8.16413672 9
241 6 -4.71909257 4.09173629 5.57326514 15
242 7 3.42713139 5.74362063 5.17254118 13
243 8 -4.83615264 2.20502275 5.02711586 12
244
245Printing exclusive jets with dcut = 25 GeV^2
246--------------------------------------------
247jet # rapidity phi pt n constituents
248 0 -0.86730713 2.90511470 983.38727662 35
249 1 0.22093749 6.02911715 898.62586887 29
250 2 -1.16520657 6.04589034 70.78886044 48
251 3 0.36257181 0.54763129 16.65531147 23
252 4 -2.34731970 1.25431317 10.72317440 18
253 5 -1.19479918 0.80734483 8.29342805 15
254 6 -1.71897064 4.01955399 8.16413672 9
255 7 -4.71909257 4.09173629 5.57326514 15
256 8 3.42713139 5.74362063 5.17254118 13
257 9 -4.83615264 2.20502275 5.02711586 12
258<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
259
260Additionally the example/ directory contains the following other
261programs
262
263- ktjet_example
264 same example program, but written with ktjet, to illustrate
265 similarities and differences with fastjet_example. For
266 compilation to work please set the KTJET_INCLUDE and
267 KTJET_LIBRARY variables in the fastjet main Makefile.
268
269- ktjet_timing
270- fastjet_timing_plugins
271 programs for testing output and timings of the two programs --
272 may be run with a variety of command-line options to control
273 behaviour -- see the beginning of fastjet_timing_plugins.cc for
274 further information.
275
276- fastjet_areas
277 example program for evaluating the areas of the jets in
278 a single event (it reads in the same input file as fastjet_example)
279
280- A number of examples named 01-XXX.cc, 02-YYY.cc, etc, where FastJet features
281 are illustrated in increasing order of complexity.
Generated on for FastJet by doxygen 1.18.0