Metadata-Version: 2.1
Name: pyBumpHunter
Version: 0.2.1
Summary: Python implementation of the BumpHenter algorithm used by HEP community.
Home-page: https://github.com/lovaslin/pyBumpHunter
Author: Louis VASLIN
Author-email: louis.vaslin@clermont.in2p3.fr
License: UNKNOWN
Description: # pyBumpHunter
        
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/lovaslin/pyBumpHunter/master)
        [![Test](https://github.com/lovaslin/pyBumpHunter/workflows/automated_testing/badge.svg)](https://github.com/lovaslin/pyBumpHunter/actions)
        
        This is a python version of the BumpHunter algorithm, see [arXiv:1101.0390, G. Choudalakis](https://arxiv.org/abs/1101.0390), designed to find localized excess (or deficit) of events in a 1D distribution.
        
        The main BumpHunter function will scan a data distribution using variable-width window sizes and calculate the p-value of data with respect to a given background distribution in each window. The minimum p-value obtained from all windows is the local p-value. To cope with the "look-elsewhere effect" a global p-value is calculated by performing background-only pseudo-experiments.
        
        The BumpHunter algorithm can also perform signal injection tests where more and more signal is injected in toy data until a given signal significance (global) is reached.
        
        ### Content
        
        * pyBumpHunter : The pyBumpHunter package
        * example/example.py : A little example script that use pyBumpHunter
        * example/example.ipynb : A little example notebook that use pyBumpHunter
        * example/results : Folder containing the outputs of example script
        * testing : Folder containing the testing scripts (based on pytest)
        * data/data.root  : Toy data used in the examples and tests
        * data/gen_data.C : Code used to generate the toy data with ROOT
        
        ### python dependancies
        
        pyBumpHunter depends on the following python libraries :
        
        * numpy
        * scipy
        * matplotlib
        
        ### [pyBumpHunter wiki](https://github.com/lovaslin/pyBumpHunter/wiki)
        
        ### Examples
        
        The examples provided in example.py and test.ipynb require the [uproot](https://github.com/scikit-hep/uproot) package in order to read the data from a [ROOT software](https://root.cern.ch/) file.
        
        The data provided in the example consists of three histograms: a steeply falling 'background' distribution in a [0,20] x-axis range, a 'signal' gaussian shape centered on a value of 5.5, and a 'data' distribution sampled from background and signal distributions, with a signal fraction of 0.15%. The data file is produced by running gen_data.C in ROOT.
        
        In order to run the example script, simply type `python3 example.py` in a terminal.
        
        You can also open the example notebook with jupyter or binder.
        
        * Bump hunting:
        
        <p align="center">
        <img src="https://raw.githubusercontent.com/lovaslin/pyBumpHunter/master/example/results/bump.png" title="drawing"  width="500">
        </p>
        
        * Tomography scan:
        
        <p align="center">
        <img src="https://raw.githubusercontent.com/lovaslin/pyBumpHunter/master/example/results/tomography.png" title="drawing"  width="500">
        </p>
        
        * Test statistics and global p-value:
        
        <p align="center">
        <img src="https://raw.githubusercontent.com/lovaslin/pyBumpHunter/master/example/results/BH_statistics.png" title="drawing"  width="500">
        </p>
        
        See the [wiki](https://github.com/lovaslin/pyBumpHunter/wiki) for a detailed overview of all the features offered by pyBumpHunter.
        
        ### To do list
        
        * Run BH on 2D histograms
        
        ### Authors and contributors
        
        Louis Vaslin (main developper), Julien Donini
        
        Thanks to Samuel Calvet for his help in cross-checking and validating pyBumpHunter against the (internal) C++ version of BumpHunter developped by the [ATLAS collaboration](https://atlas.cern/).
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: example
