|Code Health| |Build Status| |PyPI version| |DOI badge|

raredecay

This package consists of several tools for the event selection of particle decays, mostly built on machine learning techniques. It contains:

• a data-container holding data, weights, labels and more and implemented root-to-python data conversion as well as plots and KFold-data splitting
• reweighting tools from the hep_ml-repository wrapped in a KFolding structure and with metrics to evaluate the reweighting quality
• classifier optimization tools for hyper-parameters as well as feature selection involving a backward-elimination
• an output handler which makes it easy to add text as well as figures into your code and automatically save them to a file
• ... and more

HowTo examples

To get an idea of the package, have a look at the howto notebooks: HTML version <https://mayou36.bitbucket.io/raredecay/howto/>__ or the IPython Notebooks <https://github.com/mayou36/raredecay/tree/master/howto>__

Minimal example

Want to test whether your reweighting did overfit? Use train_similar:

.. code:: python

import raredecay as rd

mc_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=0)
real_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=1)

score = rd.score.train_similar(mc_data, real_data, old_mc_weights=1 *or whatever weights the mc had before*)

Getting started right now

If you want it the easy, fast way, have a look at the Ready-to-use scripts <https://github.com/mayou36/raredecay/tree/master/scripts_readyToUse>__. All you need to do is to have a look at every "TODO" task and probably change them. Then you can run the script without the need of coding at all.

Documentation and API

The API as well as the documentation: Documentation <https://mayou36.github.io/raredecay/>__

Setup and installation

It is highly recommended to perform the installation inside a conda environment. This allows to shield the installation against other packages and provides an easy way to install ROOT.

(Download and install anaconda/miniconda first)

::

conda create -n env_name python=3.8 root -c conda-forge

and switch into the environment with

::

conda activate env_name

PyPI

To install raredecay, use


::

    pip install git+https://github.com/mayou36/raredecay

*why is there no pip package?*: unfortunately, a dependency, `REP <https://github.com/yandex/rep>`_ is
unfortunately not actively maintained anymore and an `updated fork <https://github.com/REPlegacy/rep>`_ has
to be used, which is not deployed to PyPI. Therefore, `raredecay` also can't be deployed to PyPI since
depencencies are only allowed to contain other PyPI packages but no github repositories.



.. |Code Health| image:: https://landscape.io/github/mayou36/raredecay/master/landscape.svg?style=flat
   :target: https://landscape.io/github/mayou36/raredecay/master
.. |Build Status| image:: https://travis-ci.org/mayou36/raredecay.svg?branch=master
   :target: https://travis-ci.org/mayou36/raredecay
.. |PyPI version| image:: https://badge.fury.io/py/raredecay.svg
   :target: https://badge.fury.io/py/raredecay
.. |Dependency Status| image:: https://www.versioneye.com/user/projects/58273f1df09d22004f5914f9/badge.svg?style=flat-square
   :target: https://www.versioneye.com/user/projects/58273f1df09d22004f5914f9
.. |DOI badge| image:: https://zenodo.org/badge/70418004.svg
   :target: https://zenodo.org/badge/latestdoi/70418004

Citation

If you use the package in research, please consider citing <https://zenodo.org/record/1491924#.X2fCUXUzZhE>_