KLFitter is a library for kinematic fitting using a likelihood approach. It is primarily developed for the case of top quark reconstruction, but it can be easily modified to fit other processes. Detailed documentation:
- List of authors and contributors
- What is KLFitter and how does it work?
- Out-of-the-box example
- Frequently Asked Questions
KLFitter is licensed under the GNU Lesser General Public License v3.0. For more information about the licensing terms and conditions, please refer to COPYING and COPYING.lesser for the GNU General Public License and the additional terms of the GNU Lesser General Public License, respectively.
KLFitter depends on the ROOT and BAT libraries. For information about ROOT, please consult the ROOT webpage. Information about BAT, installation instructions and the latest BAT releases can be found on the library's webpage. The following versions have been tested with KLFitter and are working:
- ROOT v5.34.10 or later
- BAT v0.9.3 and v0.9.4.1
The KLFitter source code can be obtained from this repository (https://github.com/KLFitter/KLFitter). A list of all releases of KLFitter can be found under KLFitter/releases. To download the source code, you can use the git clone command:
$ git clone https://github.com/KLFitter/KLFitter.git
and, for checking out a specific release, use the git checkout procedure:
$ cd KLFitter
$ git checkout $VERSION_TAG
Before proceeding please make sure that you have a valid installation of ROOT on your system and that cmake is correctly configured (version 3.1 or higher is required). As cmake does fully automatised configuration, it is possible to build KLFitter and the BAT library simultaneously. BAT will be downloaded during the cmake build process. For doing so, change into the KLFitter directory and then do:
mkdir build && cd build
cmake -DBUILTIN_BAT=TRUE ..
make -j
This will build both BAT and KLFitter in the build subfolder of the KLFitter
directory. If you already have an existing installation of BAT, you can also
link the KLFitter library against that version and not download BAT during the
cmake build process. For that, make sure that the environment variable
$BATINSTALLDIR points to the BAT installation directory and is exported. This
variable will be used by FindBAT.cmake, which locates the BAT library. With a
local version of BAT, the -DBUILTIN_BAT flag of the cmake command can be
omitted, i.e. the KLFitter build procedure becomes:
mkdir build && cd build
cmake ..
make -j
For problems with the cmake configuration, please also refer to the Frequently Asked Questions.
The repository also comes with a Makefile, although using cmake to build
KLFitter is the recommended procedure. Compilation via Makefile assumes that
you have a working installation of ROOT and BAT. The location of the BAT library
is determined with the $BATINSTALLDIR variable, so make sure to set and export
it. Then switch to the KLFitter repository directory and call
make -j && make -j install
to compile KLFitter. The latter command will create a subdirectory build and copy the header and library files into that directory for external usage.