/root/bat/README.md
1 BAT - Bayesian Analysis Toolkit
2 ===============================
3 
4 [![Build Status](https://travis-ci.org/bat/bat.svg?branch=master)](https://travis-ci.org/bat/bat)
5 [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
6 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1203195.svg)](https://doi.org/10.5281/zenodo.1203195)
7 
8 The Bayesian Analysis Toolkit is a software analysis package which allows
9 to address the main goals of a typical data analysis:
10 
11  - compare model predictions with data,
12  - draw conclusions on the validity of the model as a representation
13  of the data and
14  - extract the possible values of parameters within the context of
15  a model.
16 
17 The BAT is based on Bayes' Theorem and is realized with the use of Markov
18 Chain Monte Carlo. This gives access to the full posterior probability
19 distribution and enables straightforward parameter estimation, limit
20 setting and uncertainty propagation.
21 
22 The BAT is implemented in C++ on top of CERN's ROOT with emphasis put
23 on flexibility and modularity in defining models while keeping in mind
24 the reliability and speed requirements of the numerical operations.
25 
26 Authors
27 --------
28 
29 See `doc/CREDITS` file for list of contributors to BAT.
30 
31 Availability
32 -------------
33 
34 All BAT releases are available from http://mpp.mpg.de/bat/. The
35 source code is managed online at https://github.com/bat/bat. BAT is
36 open-source software under the LGPLv3 or later. See `doc/COPYING` and
37 `doc/LICENSE` for licensing details.
38 
39 Contents
40 ---------
41 
42 Directory `bat/`:
43 
44 * `doc/`: documentation about BAT
45 * `examples/`: well commented example programs, see `examples/README.md`
46 * `BAT/`: BAT header files
47 * `src/`: source files of the BAT core library
48 * `models`: models for specific data-analysis problems: fast fitters
49  in `base/` and the multi-template fitter in `mtf`
50 * `benchmarks`: performance test suite with html output
51 * `test`: unit tests
52 * `tools`: template script to generate a BAT project and build utilities
53 * `INSTALL.md`: instructions to install BAT on your system
54 * `README.md`: this document
55 
56 Other files distributed with BAT are part of the configuration and
57 build system.
58 
59 Installation
60 -------------
61 
62 See the `INSTALL.md` file for installation instructions. The
63 instructions for the latest development version are also available
64 at https://github.com/bat/bat/blob/master/INSTALL.md.
65 
66 
67 Contact
68 -------------
69 
70 For additional information and contacting the authors, please consult
71 the BAT web page at http://mpp.mpg.de/bat/. If you want to report an
72 error or file a request, please file an issue at
73 https://github.com/bat/bat/issues.