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