Hist classes and utilities

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for henryiii from gravatar.com henryiii Avatar for pivarski from gravatar.com pivarski Avatar for ronreiter from gravatar.com ronreiter Avatar for scikit-hep from gravatar.com scikit-hep

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

Hist

Github Actions badge Join the chat at https://gitter.im/Scikit-HEP/hist Code style: black DOI Scikit-HEP

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 to name if not provided).
    • Indexing, projection, and more support named axes.
    • Experimental NamedHist is a Hist that disables most forms of positional access.

  • The Hist class augments bh.Histogram with reduced typing construction:

    • Optional import-free construction system
    • flow=False is a fast way to turn off flow

  • Hist implements UHI+; an extension to the UHI (Unified Histogram Indexing) system designed for import-free interactivity:

    • Uses j suffix to switch to data coordinates in access or slices
    • Uses j suffix on slices to rebin
    • Strings can be used directly to index into string category axes

  • 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")
  .Variable(range(10), name="y", label="y-axis")
  .Int64()
)

# Filling by names is allowed:
hist.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
🚧 💻 📖
N!no
🚧 💻 📖
Chris Burr
💻

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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for henryiii from gravatar.com henryiii Avatar for pivarski from gravatar.com pivarski Avatar for ronreiter from gravatar.com ronreiter Avatar for scikit-hep from gravatar.com scikit-hep

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

2.8.0

2.7.3

2.7.2

2.7.1

2.7.0 yanked

Reason this release was yanked:

iminuit requirement breaks plot extra

2.6.3

2.6.2

2.6.1

2.6.0

2.5.2

2.5.1

2.5.0

2.4.0

2.3.0

2.2.1

2.2.0

2.1.1

2.1.0

This version

2.0.1

2.0.0

2.0.0b1 pre-release

2.0.0a5 pre-release

2.0.0a4 pre-release

2.0.0a3 pre-release

2.0.0a2 pre-release

2.0.0a1 pre-release

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hist-2.0.1.tar.gz (345.8 kB view details)

Uploaded Source

Built Distribution

hist-2.0.1-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file hist-2.0.1.tar.gz.

File metadata

  • Download URL: hist-2.0.1.tar.gz
  • Upload date:
  • Size: 345.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for hist-2.0.1.tar.gz
Algorithm Hash digest
SHA256 8fb8ddf90d4b33c1c941a7ba4fb5cf8d381eae568f368c1ec1f6152967a9b065
MD5 2928317d5ac3ff9f34391598890cac2d
BLAKE2b-256 0a7b1007fb146aee9f11ef713db4bf0c939250daa468dda4a3451a6b2444020b

See more details on using hashes here.

File details

Details for the file hist-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: hist-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for hist-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 943334f39e7e4055e4bb725dcbd6c3d52bb93b753bb46fdf6f6b6fec590f6cf3
MD5 972520c3c897d13aeb80bef7785df2ed
BLAKE2b-256 c5c11b577881a248717c91e59f4932a268b632173f28aa9394944fc4a6504a02

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page