Metadata-Version: 2.1
Name: puma-hep
Version: 0.0.0rc6
Summary: Plotting API for HEP flavour tagging plots.
Home-page: https://github.com/umami-hep/puma
Keywords: machine learning,flavour tagging,plots
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# puma - Plotting UMami Api

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) 
[![Umami docs](https://img.shields.io/badge/info-documentation-informational)](https://umami-hep.github.io/puma/)
[![PyPI version](https://badge.fury.io/py/puma-hep.svg)](https://badge.fury.io/py/puma-hep)

The Python package `puma` provides a plotting API for commonly used plots in flavour tagging.

ROC curves | Histogram plots | Variable vs efficiency |
:---------:|:--------------: | :--------------------: |
<img src=https://umami-docs.web.cern.ch/ci_assets/roc.png width=200> | <img src=https://umami-docs.web.cern.ch/ci_assets/histogram_discriminant.png width=220> | <img src=https://umami-docs.web.cern.ch/ci_assets/pt_light_rej.png width=220> |


## Installation

The `puma` package is currently under construction. It can be installed from PyPI or
using the latest code from this repository.

```bash   
pip install puma-hep
# or
pip install https://github.com/umami-hep/puma/archive/master.tar.gz
```
