Hist classes and utilities
Project description
Hist
Hist is a analyst friendly front-end for boost-histogram, designed for Python 3.6+.
Installation
You can install this library from PyPI with pip:
python3 -m pip install "hist[plot]"
If you do not need the plotting features, you can skip the [plot] extra.
Features
Hist currently provides everything boost-histogram provides, and the following enhancements:
-
Hist augments axes with names:
name=is a unique label describing each axis.label=is an optional string that is used in plotting (defaults tonameif not provided).- Indexing, projection, and more support named axes.
- Experimental
NamedHistis aHistthat disables most forms of positional access.
-
The
Histclass augmentsbh.Histogramwith reduced typing construction:- Optional import-free construction system
flow=Falseis a fast way to turn off flow- Storages can be given by string
storage=can be omitted
-
Hist implements UHI+; an extension to the UHI (Unified Histogram Indexing) system designed for import-free interactivity:
- Uses
jsuffix to switch to data coordinates in access or slices - Uses
jsuffix on slices to rebin - Strings can be used directly to index into string category axes
- Uses
-
Quick plotting routines encourage exploration:
.plot()provides 1D and 2D plots.plot2d_full()shows 1D projects around a 2D plot.plot_pull(...)performs a pull plot
-
Notebook ready: Hist has gorgeous in-notebook representation.
- No dependencies required
Usage
from hist import Hist
# Quick construction, no other imports needed:
h = (
Hist.new
.Reg(10, 0 ,1, name="x", label="x-axis")
.Var(range(10), name="y", label="y-axis")
.Int64()
)
# Filling by names is allowed:
h.fill(y=[1, 4, 6], x=[3, 5, 2])
# Names can be used to manipulate the histogram:
h.project("x")
h[{"y": 0.5j + 3, "x": 5j}]
# You can access data coordinates or rebin with a `j` suffix:
h[.3j:, ::2j] # x from .3 to the end, y is rebinned by 2
# Elegant plotting functions:
h.plot()
h.plot2d_full()
h.plot_pull(Callable)
Development
From a git checkout, run:
python -m pip install -e .[dev]
See CONTRIBUTING.md for information on setting up a development environment.
Contributors
We would like to acknowledge the contributors that made this project possible (emoji key):
 Henry Schreiner 🚧 💻 📖 |
 Nino Lau 🚧 💻 📖 |
 Chris Burr 💻 |
 Eduardo Rodrigues 💻 |
This project follows the all-contributors specification.
Talks
Acknowledgements
This library was primarily developed by Henry Schreiner and Nino Lau.
Support for this work was provided by the National Science Foundation cooperative agreement OAC-1836650 (IRIS-HEP) and OAC-1450377 (DIANA/HEP). Any opinions, findings, conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the National Science Foundation.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file hist-2.1.0.tar.gz.
File metadata
- Download URL: hist-2.1.0.tar.gz
- Upload date:
- Size: 347.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8b8fa7add180ad0f1c917772bfc969a5c39587a4e4d91acecbd85bbd45d09a12 |
|
| MD5 | 88a00e0bf2146773566fa893bb8e5624 |
|
| BLAKE2b-256 | 9f4851ff9dcee0d29a6dbca280f08e35119db32fa838f365b0d05a426f7a94e8 |
File details
Details for the file hist-2.1.0-py3-none-any.whl.
File metadata
- Download URL: hist-2.1.0-py3-none-any.whl
- Upload date:
- Size: 20.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e9e21519e99d26bc92828e605bcdbdf62f86031be3673ea12547ce79ab182c79 |
|
| MD5 | d7fd74b07b985effcac1364c1bb73393 |
|
| BLAKE2b-256 | 803d2f5ed353621c5123e0142e1c5d7488a10e66c30e28a4a4bcdc550383a56d |
