Metadata-Version: 2.1
Name: hist
Version: 2.0.0a3
Summary: Hist classes and utilities
Home-page: https://github.com/scikit-hep/hist
Author: Henry Schreiner
Author-email: henry.schreiner@cern.ch
Maintainer: The Scikit-HEP admins
Maintainer-email: scikit-hep-admins@googlegroups.com
License: BSD 3-Clause License
Keywords: histogram,boost-histogram
Platform: Any
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.13.3)
Requires-Dist: boost-histogram (==0.9.0)
Requires-Dist: matplotlib (>=2.0)
Requires-Dist: scipy (>=1.4.1)
Requires-Dist: uncertainties (>=3)
Requires-Dist: histoprint (>=1.4.0)
Requires-Dist: typing-extensions ; python_version < "3.8"
Provides-Extra: dev
Requires-Dist: pytest (>=4.6) ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: recommonmark (>=0.5.0) ; extra == 'docs'
Requires-Dist: Sphinx (>=2.0.0) ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: mpl
Requires-Dist: matplotlib (>=2.0) ; extra == 'mpl'
Provides-Extra: test
Requires-Dist: pytest (>=4.6) ; extra == 'test'

# Hist

[![Github Actions badge](https://github.com/scikit-hep/hist/workflows/CI/badge.svg)](https://github.com/scikit-hep/hist/actions)
[![Join the chat at https://gitter.im/Scikit-HEP/hist](https://badges.gitter.im/HSF/PyHEP-histogramming.svg)](https://gitter.im/HSF/PyHEP-histogramming?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)


Development for Hist. See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on setting up a development environment.

Hist is a analyst friendly front-end for [boost-histogram][].

Hist augments metadata by adding names to axes; these are *highly* recommend and will help you track axes. There is also a special `NamedHist`, which will enforce all hist axes have names, and all axes will require named access.

* `name=` is a unique label describing each axis
* `title=` is an optional string that is used in plotting (defaults to name if not provided)
* Indexing, projection, and more support named axes.

The `Hist` class augments the `bh.Histogram` class with the following shortcuts, designed for interactive exploration without extensive imports:

* Optional import-free construction system
* Quick import-free data-coordinates and rebin syntax (use a j suffix for numbers, or strings directly in indexing expressions)

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



[boost-histogram]: https://github.com/scikit-hep/boost-histogram

---

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.


