FastJet  3.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
README
1 ----------------------------------------------------------------------
2 FastJet
3 -------
4 
5 The FastJet package, written by Matteo Cacciari and Gavin Salam and
6 Gregory Soyez, provides a fast implementation of several
7 longitudinally invariant sequential recombination jet algorithms, in
8 particular the longitudinally invariant kt jet algorithm, the
9 inclusive longitudinally invariant version of the Cambridge/Aachen
10 jet-algorithm, and the inclusive anti-kt algorithm.
11 
12 The implementation is based on the geometrical methods described in
13 M. Cacciari and G.P. Salam, Phys. Lett. B 641 (2006) 57
14 [hep-ph/0512210]. The full FastJet manual is available as
15 doc/fastjet-doc.tex and also as arXiv:1111.6097.
16 
17 Means are also provided for accessing external jet-algorithm software
18 via a common (plugin) interface and the package notably includes
19 SISCone, an infrared safe seedless stable-cone type algorithm introduced
20 in G.P. Salam and G. Soyez, JHEP 0705 (2007) 086 [arXiv:0704.0292].
21 
22 Various tools are also provided related to jet areas and
23 subtraction. They can be used with any infrared safe jet algorithm,
24 both native and plugin. The ideas behind them are described in
25 M. Cacciari, G.P. Salam, Phys.Lett.B 659 (2008) 119 [arXiv:0707.1378], and
26 M. Cacciari, G.P. Salam and G. Soyez, JHEP 0804 (2008) 005 [arXiv:0802.1188]
27 
28 Tools are also provided to facilitate jet substructure analyses.
29 
30 ----------------------------------------------------------------------
31 Installation
32 ------------
33 Installation instructions are provided in the INSTALL file.
34 
35 Note that to benefit from NlnN implementation (relevant for a number
36 of particles N greater than 15000 roughly) of the kt (and anti-kt) jet
37 algorithm , you will need to download CGAL from http://www.cgal.org/
38 and compile it before compiling the FastJet library. The NlnN
39 implementation of the Cambridge/Aachen jet-algorithm is independent of
40 CGAL.
41 
42 Automatic documentation can be generated by running the doxygen command
43 (if not installed on your system see www.doxygen.org) in the main
44 directory. It will create the html/ and latex/ directories containing
45 detailed documentation of all classes etc.. More standard
46 documentation is to be found in the doc/ directory.
47 
48 ----------------------------------------------------------------------
49 Directory structure
50 -------------------
51 
52 doc/ Documentation
53 src/ the .cc files for the FastJet library
54 include/ the include (.hh) files for the FastJet library
55 example/ contains example programs (list them with "ls -1 [0-9]*.cc")
56 example/data/ contains files with data for example events
57 example/root/ an example root script to show jets as calorimeter towers
58 plugins/ the various plugin jet algorithms
59 tools/ location for a number of the tools (substructure, etc.)
60 fortran_wrapper/ an illustration of how to use fastjet from fortran
61 
62 ----------------------------------------------------------------------
63 Known bugs
64 ----------
65 
66 See the BUGS file as well as the web page, http://fastjet.fr/ for
67 information discovered subsequent to the release.
68