| Name | uhi JSON |
| Version |
0.3.3
JSON |
| download |
| home_page | |
| Summary | Unified Histogram Interface: tools to help library authors work with histograms |
| upload_time | 2023-01-04 15:47:37 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | BSD 3-Clause License Copyright (c) 2021, Henry Schreiner. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the vector package developers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 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]
[![Scikit-HEP][sk-badge]](https://scikit-hep.org/)
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). It requires 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
[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
[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": "",
"name": "uhi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "The Scikit-HEP admins <scikit-hep-admins@googlegroups.com>",
"keywords": "",
"author": "",
"author_email": "Henry Schreiner <henryschreineriii@gmail.com>, Hans Dembinski <hans.dembinski@gmail.com>, Jim Pivaski <pivarski@princeton.edu>",
"download_url": "https://files.pythonhosted.org/packages/3b/68/6b97b6093f7bd59d093604021f453adcfe97a09c704bf8db1130217d1c80/uhi-0.3.3.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[![Scikit-HEP][sk-badge]](https://scikit-hep.org/)\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). It requires 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[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\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": "BSD 3-Clause License Copyright (c) 2021, Henry Schreiner. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the vector package developers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Unified Histogram Interface: tools to help library authors work with histograms",
"version": "0.3.3",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "70e7599c0589e0fcb3f330ea6cc13b3fde9d3f0a65fe939f9b5634c50dde6349",
"md5": "c0febe239df759a1fb89ef2640a43db6",
"sha256": "4805a4194550310ee2a58aa8c777e6ab80f8896c96469d7c16fd2436aef4c9c3"
},
"downloads": -1,
"filename": "uhi-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0febe239df759a1fb89ef2640a43db6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 11198,
"upload_time": "2023-01-04T15:47:35",
"upload_time_iso_8601": "2023-01-04T15:47:35.935493Z",
"url": "https://files.pythonhosted.org/packages/70/e7/599c0589e0fcb3f330ea6cc13b3fde9d3f0a65fe939f9b5634c50dde6349/uhi-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b686b97b6093f7bd59d093604021f453adcfe97a09c704bf8db1130217d1c80",
"md5": "225c6d8c7d6285d0ec49f65eaac3df05",
"sha256": "800caf3a5f1273b08bcc3bb4b49228fe003942e23423812b0110546aad9a24be"
},
"downloads": -1,
"filename": "uhi-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "225c6d8c7d6285d0ec49f65eaac3df05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 52109,
"upload_time": "2023-01-04T15:47:37",
"upload_time_iso_8601": "2023-01-04T15:47:37.303945Z",
"url": "https://files.pythonhosted.org/packages/3b/68/6b97b6093f7bd59d093604021f453adcfe97a09c704bf8db1130217d1c80/uhi-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-04 15:47:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "uhi"
}
