Skip to main content

Unified Histogram Interface: tools to help library authors work with histograms

Project description

UHI: Universal Histogram Interface

Actions Status Documentation Status pre-commit.ci Status Code style: black

PyPI version Conda-forge version PyPI platforms

GitHub Discussion Gitter Scikit-HEP

This is a package meant primarily for documenting histogram indexing and the PlottableHistogram Protocol and any future cross-library standards. It also contains the code for the PlottableHistogram Protocol, to be used in type checking libraries wanting to conform to the protocol. Eventually, it might gain a set of tools for testing conformance to UHI indexing, as well. It is not usually a runtime dependency, but only a type checking, testing, and/or docs dependency in support of other libraries (such as boost-histogram 0.13+, hist 2.1+, mplhep 0.2.15+, uproot 4+, and histoprint 2+). There are a few useful runtime usable components (listed below). It requires Python 3.6+. See what's new.

To assist plotting libraries in accepting Histograms from classic sources, see uhi.numpy_plottable.ensure_plottable_histogram, which will adapt NumPy style tuples into a simple PlottableHistogram.

The Protocols provided do support runtime checking, so isinstance(h, uhi.typing.plotting.PlottableHistogram) is valid at runtime and might be simpler than manually checking for the expected methods.

Project details


Download files

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

Source Distribution

uhi-0.3.3.tar.gz (52.1 kB view details)

Uploaded Source

Built Distribution

uhi-0.3.3-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file uhi-0.3.3.tar.gz.

File metadata

  • Download URL: uhi-0.3.3.tar.gz
  • Upload date:
  • Size: 52.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for uhi-0.3.3.tar.gz
Algorithm Hash digest
SHA256 800caf3a5f1273b08bcc3bb4b49228fe003942e23423812b0110546aad9a24be
MD5 225c6d8c7d6285d0ec49f65eaac3df05
BLAKE2b-256 3b686b97b6093f7bd59d093604021f453adcfe97a09c704bf8db1130217d1c80

See more details on using hashes here.

File details

Details for the file uhi-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: uhi-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for uhi-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4805a4194550310ee2a58aa8c777e6ab80f8896c96469d7c16fd2436aef4c9c3
MD5 c0febe239df759a1fb89ef2640a43db6
BLAKE2b-256 70e7599c0589e0fcb3f330ea6cc13b3fde9d3f0a65fe939f9b5634c50dde6349

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