puma - Plotting UMami Api
The Python package puma provides a plotting API for commonly used plots in flavour tagging.
| ROC curves | Histogram plots | Variable vs efficiency |
|---|---|---|
 |
 |
 |
Installation
puma can be installed from PyPI or using the latest code from this repository.
Install latest release from PyPI
pip install puma-hep
The installation from PyPI only allows to install tagged releases, meaning you can not
install the latest code from this repo using the above command.
If you just want to use a stable release of puma, this is the way to go.
Install latest version from GitHub
pip install https://github.com/umami-hep/puma/archive/main.tar.gz
This will install the latest version of puma, i.e. the current version
from the main branch (no matter if it is a release/tagged commit).
If you plan on contributing to puma and/or want the latest version possible, this
is what you want.
Install for development with uv (recommended)
For development, we recommend using uv, a fast Python package installer and resolver. First, install uv:
# On macOS and Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
# On Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
# Or with pip (If installing from PyPI, we recommend installing uv into an isolated environment)
pip install uv
Then clone the repository and install puma with development dependencies:
git clone https://github.com/umami-hep/puma.git
cd puma
uv sync --extra dev
This will install puma in editable mode along with all development tools (testing, linting, etc.).
Docker images
The Docker images are built on GitHub and contain the latest version from the main branch.
The container registry with all available tags can be found here.
The puma:latest image is based on python:3.11.10-bullseye and is meant for users who want to use the latest version of puma. For each release, there is a corresponding tagged image.
You can start an interactive shell in a container with your current working directory
mounted into the container by using one of the commands provided below.
On a machine with Docker installed:
docker run -it --rm -v $PWD:/puma_container -w /puma_container gitlab-registry.cern.ch/aft/training-images/puma-images/puma:latest bash
On a machine/cluster with singularity installed:
singularity shell -B $PWD docker://gitlab-registry.cern.ch/aft/training-images/puma-images/puma:latest
The images are automatically updated via GitHub and pushed to this repository registry.
2 maintainers
Metadata
2 maintainers
Release files for puma-hep 0.5.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| puma_hep-0.5.5.tar.gz | 94.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| puma_hep-0.5.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 201.8 kB
Release files / puma_hep-0.5.5.tar.gz
| Download URL | puma_hep-0.5.5.tar.gz |
|---|---|
| Size | 94.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1c63b6067b25811527083dc2ecfea03c4362c79dbe2417cf542b720d3ba73b32
|
|
BLAKE2b-256 checksum How to use checksums |
58c894792b0678b06cf3561613687dfb638209db2a34a8d84cc0148f61283aaf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / puma_hep-0.5.5-py3-none-any.whl
| Download URL | puma_hep-0.5.5-py3-none-any.whl |
|---|---|
| Size | 106.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7671d2887a0fdeb02f764ecbeed5764b817bceb6a91327770bf84885970283b8
|
|
BLAKE2b-256 checksum How to use checksums |
2d5228156a9f1f460f9428d3ca5f32a73c1414afc37b55dc6d2f35ac3bc01d49
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
