| Name | uhi JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Unified Histogram Interface: tools to help library authors work with histograms |
| upload_time | 2025-08-20 20:19:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# UHI: Universal Histogram Interface
[![Actions Status][actions-badge]][actions-link]
[![Documentation Status][rtd-badge]][rtd-link]
[![pre-commit.ci Status][pre-commit-badge]][pre-commit-link]
[![Code style: black][black-badge]][black-link]
[![PyPI version][pypi-version]][pypi-link]
[![Conda-forge version][conda-badge]][conda-link]
[![PyPI platforms][pypi-platforms]][pypi-link]
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
[![Gitter][gitter-badge]][gitter-link]
[![Zenodo][zenodo-badge]][zenodo-link]
[![Scikit-HEP][sk-badge]](https://scikit-hep.org/)
[![SPEC 4 — Using and Creating Nightly Wheels][spec4-badge]][spec4-link]
This is a package meant primarily for [documenting][rtd-link] 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). Older versions are available for Python 3.6+. [See what's
new](https://github.com/scikit-hep/uhi/releases).
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.
[actions-badge]: https://github.com/Scikit-HEP/uhi/workflows/CI/badge.svg
[actions-link]: https://github.com/Scikit-HEP/uhi/actions
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/psf/black
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/uhi
[conda-link]: https://github.com/conda-forge/uhi-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]: https://github.com/Scikit-HEP/uhi/discussions
[gitter-badge]: https://badges.gitter.im/https://github.com/Scikit-HEP/uhi/community.svg
[gitter-link]: https://gitter.im/https://github.com/Scikit-HEP/uhi/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
[zenodo-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.13883674.svg
[zenodo-link]: https://doi.org/10.5281/zenodo.13883674
[pre-commit-badge]: https://results.pre-commit.ci/badge/github/scikit-hep/uhi/main.svg
[pre-commit-link]: https://results.pre-commit.ci/repo/github/309772485
[pypi-link]: https://pypi.org/project/uhi/
[pypi-platforms]: https://img.shields.io/pypi/pyversions/uhi
[pypi-version]: https://badge.fury.io/py/uhi.svg
[rtd-badge]: https://readthedocs.org/projects/uhi/badge/?version=latest
[rtd-link]: https://uhi.readthedocs.io/en/latest/?badge=latest
[sk-badge]: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
[spec4-badge]: https://img.shields.io/badge/SPEC-4-green?labelColor=%23004811&color=%235CA038
[spec4-link]: https://scientific-python.org/specs/spec-0004/
[boost-histogram]: https://github.com/scikit-hep/boost-histogram
[hist]: https://github.com/scikit-hep/hist
[mplhep]: https://github.com/scikit-hep/mplhep
[uproot]: https://github.com/scikit-hep/uproot4
[histoprint]: https://github.com/scikit-hep/histoprint
Raw data
{
"_id": null,
"home_page": null,
"name": "uhi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "The Scikit-HEP admins <scikit-hep-admins@googlegroups.com>",
"keywords": null,
"author": null,
"author_email": "Henry Schreiner <henryschreineriii@gmail.com>, Hans Dembinski <hans.dembinski@gmail.com>, Jim Pivaski <jpivarski@gmail.com>, Silia Taider <siliataider@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/4c/846ed661a6454fcb3a27fc5f8d26f8170718d3fc85e784cf1b8b2718185e/uhi-1.0.0.tar.gz",
"platform": null,
"description": "# UHI: Universal Histogram Interface\n\n[![Actions Status][actions-badge]][actions-link]\n[![Documentation Status][rtd-badge]][rtd-link]\n[![pre-commit.ci Status][pre-commit-badge]][pre-commit-link]\n[![Code style: black][black-badge]][black-link]\n\n[![PyPI version][pypi-version]][pypi-link]\n[![Conda-forge version][conda-badge]][conda-link]\n[![PyPI platforms][pypi-platforms]][pypi-link]\n\n[![GitHub Discussion][github-discussions-badge]][github-discussions-link]\n[![Gitter][gitter-badge]][gitter-link]\n[![Zenodo][zenodo-badge]][zenodo-link]\n[![Scikit-HEP][sk-badge]](https://scikit-hep.org/)\n[![SPEC 4 \u2014 Using and Creating Nightly Wheels][spec4-badge]][spec4-link]\n\n\nThis is a package meant primarily for [documenting][rtd-link] histogram\nindexing and the PlottableHistogram Protocol and any future cross-library\nstandards. It also contains the code for the PlottableHistogram Protocol, to be\nused in type checking libraries wanting to conform to the protocol. Eventually,\nit might gain a set of tools for testing conformance to UHI indexing, as well.\nIt is not usually a runtime dependency, but only a type checking, testing,\nand/or docs dependency in support of other libraries (such as\n[boost-histogram][] 0.13+, [hist][] 2.1+, [mplhep][] 0.2.15+, [uproot][] 4+,\nand [histoprint][] 2+). There are a few useful runtime usable components\n(listed below). Older versions are available for Python 3.6+. [See what's\nnew](https://github.com/scikit-hep/uhi/releases).\n\nTo assist plotting libraries in accepting Histograms from classic sources, see\n`uhi.numpy_plottable.ensure_plottable_histogram`, which will adapt NumPy style\ntuples into a simple PlottableHistogram.\n\nThe Protocols provided do support runtime checking, so\n`isinstance(h, uhi.typing.plotting.PlottableHistogram)` is valid at runtime and\nmight be simpler than manually checking for the expected methods.\n\n[actions-badge]: https://github.com/Scikit-HEP/uhi/workflows/CI/badge.svg\n[actions-link]: https://github.com/Scikit-HEP/uhi/actions\n[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[black-link]: https://github.com/psf/black\n[conda-badge]: https://img.shields.io/conda/vn/conda-forge/uhi\n[conda-link]: https://github.com/conda-forge/uhi-feedstock\n[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github\n[github-discussions-link]: https://github.com/Scikit-HEP/uhi/discussions\n[gitter-badge]: https://badges.gitter.im/https://github.com/Scikit-HEP/uhi/community.svg\n[gitter-link]: https://gitter.im/https://github.com/Scikit-HEP/uhi/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge\n[zenodo-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.13883674.svg\n[zenodo-link]: https://doi.org/10.5281/zenodo.13883674\n[pre-commit-badge]: https://results.pre-commit.ci/badge/github/scikit-hep/uhi/main.svg\n[pre-commit-link]: https://results.pre-commit.ci/repo/github/309772485\n[pypi-link]: https://pypi.org/project/uhi/\n[pypi-platforms]: https://img.shields.io/pypi/pyversions/uhi\n[pypi-version]: https://badge.fury.io/py/uhi.svg\n[rtd-badge]: https://readthedocs.org/projects/uhi/badge/?version=latest\n[rtd-link]: https://uhi.readthedocs.io/en/latest/?badge=latest\n[sk-badge]: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg\n[spec4-badge]: https://img.shields.io/badge/SPEC-4-green?labelColor=%23004811&color=%235CA038\n[spec4-link]: https://scientific-python.org/specs/spec-0004/\n\n[boost-histogram]: https://github.com/scikit-hep/boost-histogram\n[hist]: https://github.com/scikit-hep/hist\n[mplhep]: https://github.com/scikit-hep/mplhep\n[uproot]: https://github.com/scikit-hep/uproot4\n[histoprint]: https://github.com/scikit-hep/histoprint\n",
"bugtrack_url": null,
"license": null,
"summary": "Unified Histogram Interface: tools to help library authors work with histograms",
"version": "1.0.0",
"project_urls": {
"Changelog": "https://github.com/scikit-hep/uhi/releases",
"Documentation": "https://uhi.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Scikit-HEP/uhi",
"Repository": "https://github.com/Scikit-HEP/uhi"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3383b5be6755c33d1fa6df51dda11beb15bb4c873b66d9dc7b99aa011d4090c9",
"md5": "0de4997bef250bbdd127ad8e4560d360",
"sha256": "653e5b011aaeea0bede4feef5c4b4f3fe750277ab9c9f3d620f1a0acdc7ae740"
},
"downloads": -1,
"filename": "uhi-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0de4997bef250bbdd127ad8e4560d360",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25330,
"upload_time": "2025-08-20T20:19:14",
"upload_time_iso_8601": "2025-08-20T20:19:14.449822Z",
"url": "https://files.pythonhosted.org/packages/33/83/b5be6755c33d1fa6df51dda11beb15bb4c873b66d9dc7b99aa011d4090c9/uhi-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6f4c846ed661a6454fcb3a27fc5f8d26f8170718d3fc85e784cf1b8b2718185e",
"md5": "e9c828aaa9d5370bdc1f9f415f93086f",
"sha256": "331188949b1a49c8db9ef9d50b7c4d4df4606115d147ded97c4f050da8270e74"
},
"downloads": -1,
"filename": "uhi-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e9c828aaa9d5370bdc1f9f415f93086f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 43498,
"upload_time": "2025-08-20T20:19:15",
"upload_time_iso_8601": "2025-08-20T20:19:15.868029Z",
"url": "https://files.pythonhosted.org/packages/6f/4c/846ed661a6454fcb3a27fc5f8d26f8170718d3fc85e784cf1b8b2718185e/uhi-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 20:19:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scikit-hep",
"github_project": "uhi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "uhi"
}
