![Boost histogram logo](_images/BoostHistogramPythonLogo.png)

# Welcome to boost-histogram’s documentation!

[![Actions Status](https://github.com/scikit-hep/boost-histogram/workflows/Tests/badge.svg)](https://github.com/scikit-hep/boost-histogram/actions) [![Documentation Status](https://readthedocs.org/projects/boost-histogram/badge/?version=latest)](https://boost-histogram.readthedocs.io/en/latest/?badge=latest) [![PyPI version](https://badge.fury.io/py/boost-histogram.svg)](https://pypi.org/project/boost-histogram) [![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/boost-histogram)](https://github.com/conda-forge/boost-histogram-feedstock)
[![PyPI platforms](https://img.shields.io/pypi/pyversions/boost-histogram)](https://pypi.org/project/boost-histogram/) [![DOI](https://zenodo.org/badge/148885351.svg)](https://zenodo.org/badge/latestdoi/148885351) [![GitHub Discussion](https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github)](https://github.com/scikit-hep/boost-histogram/discussions) [![Scikit-HEP](https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg)](https://scikit-hep.org/)

Boost-histogram ([source](https://github.com/scikit-hep/boost-histogram)) is
a Python package providing Python bindings for [Boost.Histogram](https://www.boost.org/doc/libs/release/libs/histogram/doc/html/index.html) ([source](https://github.com/boostorg/histogram)).  You can install this library from
[PyPI](https://pypi.org/project/boost-histogram/) with pip or you can use
Conda via [conda-forge](https://github.com/conda-forge/boost-histogram-feedstock):

```bash
python -m pip install boost-histogram
```

```bash
conda install -c conda-forge boost-histogram
```

All the normal best-practices for Python apply; you should be in a
virtual environment, etc. See [Installation](user-guide/installation.html.md#usage-installation) for more details. An example of usage:

```python3
import boost_histogram as bh

# Compose axis however you like; this is a 2D histogram
hist = bh.Histogram(bh.axis.Regular(2, 0, 1), bh.axis.Regular(4, 0.0, 1.0))

# Filling can be done with arrays, one per dimension
hist.fill([0.3, 0.5, 0.2], [0.1, 0.4, 0.9])

# NumPy array view into histogram counts, no overflow bins
counts = hist.view()
```

See [Quickstart](user-guide/quickstart.html.md#usage-quickstart) for more.

# User Guide:

* [Installation](user-guide/installation.html.md)
* [Quickstart](user-guide/quickstart.html.md)
* [Histogram](user-guide/histogram.html.md)
* [Axes](user-guide/axes.html.md)
* [Storages](user-guide/storage.html.md)
* [Accumulators](user-guide/accumulators.html.md)
* [Using Transforms](user-guide/transforms.html.md)
* [Indexing](user-guide/indexing.html.md)
* [Plotting](user-guide/plotting.html.md)
* [Analyses examples](user-guide/analyses.html.md)
* [NumPy compatibility](user-guide/numpy.html.md)
* [Subclassing (advanced)](user-guide/subclassing.html.md)
* [Comparison with Boost.Histogram](user-guide/comparison.html.md)

# Examples:

* [Simple Example](notebooks/SimpleExample.html.md)
* [MultiCell histograms](notebooks/MultiCellExample.html.md)
* [Threaded Fills](notebooks/ThreadedFills.html.md)
* [Performance Comparison](notebooks/PerformanceComparison.html.md)
* [XArray Example](notebooks/xarray.html.md)
* [Using boost-histogram](notebooks/BoostHistogramHandsOn.html.md)

# Developers

* [Contributing](contributing.html.md)
* [Support](support.html.md)
* [Changelog](changelog.html.md)

# API Reference:

* [boost_histogram](api/boost_histogram.html.md)
  * [`Histogram`](api/boost_histogram.html.md#boost_histogram.Histogram)
    * [`Histogram.allclose()`](api/boost_histogram.html.md#boost_histogram.Histogram.allclose)
    * [`Histogram.axes`](api/boost_histogram.html.md#boost_histogram.Histogram.axes)
    * [`Histogram.copy()`](api/boost_histogram.html.md#boost_histogram.Histogram.copy)
    * [`Histogram.counts()`](api/boost_histogram.html.md#boost_histogram.Histogram.counts)
    * [`Histogram.empty()`](api/boost_histogram.html.md#boost_histogram.Histogram.empty)
    * [`Histogram.fill()`](api/boost_histogram.html.md#boost_histogram.Histogram.fill)
    * [`Histogram.kind`](api/boost_histogram.html.md#boost_histogram.Histogram.kind)
    * [`Histogram.ndim`](api/boost_histogram.html.md#boost_histogram.Histogram.ndim)
    * [`Histogram.project()`](api/boost_histogram.html.md#boost_histogram.Histogram.project)
    * [`Histogram.reset()`](api/boost_histogram.html.md#boost_histogram.Histogram.reset)
    * [`Histogram.shape`](api/boost_histogram.html.md#boost_histogram.Histogram.shape)
    * [`Histogram.size`](api/boost_histogram.html.md#boost_histogram.Histogram.size)
    * [`Histogram.storage`](api/boost_histogram.html.md#boost_histogram.Histogram.storage)
    * [`Histogram.storage_type`](api/boost_histogram.html.md#boost_histogram.Histogram.storage_type)
    * [`Histogram.sum()`](api/boost_histogram.html.md#boost_histogram.Histogram.sum)
    * [`Histogram.to_numpy()`](api/boost_histogram.html.md#boost_histogram.Histogram.to_numpy)
    * [`Histogram.values()`](api/boost_histogram.html.md#boost_histogram.Histogram.values)
    * [`Histogram.variances()`](api/boost_histogram.html.md#boost_histogram.Histogram.variances)
    * [`Histogram.view()`](api/boost_histogram.html.md#boost_histogram.Histogram.view)
  * [`Kind`](api/boost_histogram.html.md#boost_histogram.Kind)
    * [`Kind.COUNT`](api/boost_histogram.html.md#boost_histogram.Kind.COUNT)
    * [`Kind.MEAN`](api/boost_histogram.html.md#boost_histogram.Kind.MEAN)
  * [`loc`](api/boost_histogram.html.md#boost_histogram.loc)
    * [`loc.value`](api/boost_histogram.html.md#boost_histogram.loc.value)
  * [`rebin`](api/boost_histogram.html.md#boost_histogram.rebin)
    * [`rebin.axis`](api/boost_histogram.html.md#boost_histogram.rebin.axis)
    * [`rebin.axis_mapping()`](api/boost_histogram.html.md#boost_histogram.rebin.axis_mapping)
    * [`rebin.edges`](api/boost_histogram.html.md#boost_histogram.rebin.edges)
    * [`rebin.factor`](api/boost_histogram.html.md#boost_histogram.rebin.factor)
    * [`rebin.group_mapping()`](api/boost_histogram.html.md#boost_histogram.rebin.group_mapping)
    * [`rebin.groups`](api/boost_histogram.html.md#boost_histogram.rebin.groups)
  * [`sum()`](api/boost_histogram.html.md#boost_histogram.sum)
* [boost_histogram.axis](api/boost_histogram.html.md#module-boost_histogram.axis)
  * [`ArrayTuple`](api/boost_histogram.html.md#boost_histogram.axis.ArrayTuple)
    * [`ArrayTuple.broadcast()`](api/boost_histogram.html.md#boost_histogram.axis.ArrayTuple.broadcast)
  * [`AxesTuple`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple)
    * [`AxesTuple.bin()`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.bin)
    * [`AxesTuple.centers`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.centers)
    * [`AxesTuple.edges`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.edges)
    * [`AxesTuple.extent`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.extent)
    * [`AxesTuple.index()`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.index)
    * [`AxesTuple.size`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.size)
    * [`AxesTuple.value()`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.value)
    * [`AxesTuple.widths`](api/boost_histogram.html.md#boost_histogram.axis.AxesTuple.widths)
  * [`Axis`](api/boost_histogram.html.md#boost_histogram.axis.Axis)
    * [`Axis.bin()`](api/boost_histogram.html.md#boost_histogram.axis.Axis.bin)
    * [`Axis.centers`](api/boost_histogram.html.md#boost_histogram.axis.Axis.centers)
    * [`Axis.edges`](api/boost_histogram.html.md#boost_histogram.axis.Axis.edges)
    * [`Axis.extent`](api/boost_histogram.html.md#boost_histogram.axis.Axis.extent)
    * [`Axis.index()`](api/boost_histogram.html.md#boost_histogram.axis.Axis.index)
    * [`Axis.size`](api/boost_histogram.html.md#boost_histogram.axis.Axis.size)
    * [`Axis.traits`](api/boost_histogram.html.md#boost_histogram.axis.Axis.traits)
    * [`Axis.value()`](api/boost_histogram.html.md#boost_histogram.axis.Axis.value)
    * [`Axis.widths`](api/boost_histogram.html.md#boost_histogram.axis.Axis.widths)
  * [`Boolean`](api/boost_histogram.html.md#boost_histogram.axis.Boolean)
  * [`IntCategory`](api/boost_histogram.html.md#boost_histogram.axis.IntCategory)
  * [`Integer`](api/boost_histogram.html.md#boost_histogram.axis.Integer)
  * [`Regular`](api/boost_histogram.html.md#boost_histogram.axis.Regular)
    * [`Regular.transform`](api/boost_histogram.html.md#boost_histogram.axis.Regular.transform)
  * [`StrCategory`](api/boost_histogram.html.md#boost_histogram.axis.StrCategory)
    * [`StrCategory.index()`](api/boost_histogram.html.md#boost_histogram.axis.StrCategory.index)
  * [`Traits`](api/boost_histogram.html.md#boost_histogram.axis.Traits)
    * [`Traits.circular`](api/boost_histogram.html.md#boost_histogram.axis.Traits.circular)
    * [`Traits.continuous`](api/boost_histogram.html.md#boost_histogram.axis.Traits.continuous)
    * [`Traits.discrete`](api/boost_histogram.html.md#boost_histogram.axis.Traits.discrete)
    * [`Traits.growth`](api/boost_histogram.html.md#boost_histogram.axis.Traits.growth)
    * [`Traits.ordered`](api/boost_histogram.html.md#boost_histogram.axis.Traits.ordered)
    * [`Traits.overflow`](api/boost_histogram.html.md#boost_histogram.axis.Traits.overflow)
    * [`Traits.underflow`](api/boost_histogram.html.md#boost_histogram.axis.Traits.underflow)
  * [`Variable`](api/boost_histogram.html.md#boost_histogram.axis.Variable)
* [boost_histogram.axis.transform](api/boost_histogram.html.md#module-boost_histogram.axis.transform)
  * [`AxisTransform`](api/boost_histogram.html.md#boost_histogram.axis.transform.AxisTransform)
    * [`AxisTransform.forward()`](api/boost_histogram.html.md#boost_histogram.axis.transform.AxisTransform.forward)
    * [`AxisTransform.inverse()`](api/boost_histogram.html.md#boost_histogram.axis.transform.AxisTransform.inverse)
  * [`Function`](api/boost_histogram.html.md#boost_histogram.axis.transform.Function)
  * [`Pow`](api/boost_histogram.html.md#boost_histogram.axis.transform.Pow)
    * [`Pow.power`](api/boost_histogram.html.md#boost_histogram.axis.transform.Pow.power)
* [boost_histogram.accumulators](api/boost_histogram.html.md#module-boost_histogram.accumulators)
  * [`Accumulator`](api/boost_histogram.html.md#boost_histogram.accumulators.Accumulator)
* [boost_histogram.histogram](api/boost_histogram.html.md#module-boost_histogram.histogram)
  * [`Histogram`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram)
    * [`Histogram.allclose()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.allclose)
    * [`Histogram.axes`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.axes)
    * [`Histogram.copy()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.copy)
    * [`Histogram.counts()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.counts)
    * [`Histogram.empty()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.empty)
    * [`Histogram.fill()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.fill)
    * [`Histogram.kind`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.kind)
    * [`Histogram.ndim`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.ndim)
    * [`Histogram.project()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.project)
    * [`Histogram.reset()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.reset)
    * [`Histogram.shape`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.shape)
    * [`Histogram.size`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.size)
    * [`Histogram.storage`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.storage)
    * [`Histogram.storage_type`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.storage_type)
    * [`Histogram.sum()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.sum)
    * [`Histogram.to_numpy()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.to_numpy)
    * [`Histogram.values()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.values)
    * [`Histogram.variances()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.variances)
    * [`Histogram.view()`](api/boost_histogram.html.md#boost_histogram.histogram.Histogram.view)
  * [`Kind`](api/boost_histogram.html.md#boost_histogram.histogram.Kind)
    * [`Kind.COUNT`](api/boost_histogram.html.md#boost_histogram.histogram.Kind.COUNT)
    * [`Kind.MEAN`](api/boost_histogram.html.md#boost_histogram.histogram.Kind.MEAN)
* [boost_histogram.numpy](api/boost_histogram.html.md#module-boost_histogram.numpy)
  * [`histogram()`](api/boost_histogram.html.md#boost_histogram.numpy.histogram)
  * [`histogram2d()`](api/boost_histogram.html.md#boost_histogram.numpy.histogram2d)
  * [`histogramdd()`](api/boost_histogram.html.md#boost_histogram.numpy.histogramdd)
* [boost_histogram.storage](api/boost_histogram.html.md#module-boost_histogram.storage)
  * [`AtomicInt64`](api/boost_histogram.html.md#boost_histogram.storage.AtomicInt64)
    * [`AtomicInt64.accumulator`](api/boost_histogram.html.md#boost_histogram.storage.AtomicInt64.accumulator)
  * [`Double`](api/boost_histogram.html.md#boost_histogram.storage.Double)
    * [`Double.accumulator`](api/boost_histogram.html.md#boost_histogram.storage.Double.accumulator)
  * [`Int64`](api/boost_histogram.html.md#boost_histogram.storage.Int64)
    * [`Int64.accumulator`](api/boost_histogram.html.md#boost_histogram.storage.Int64.accumulator)
  * [`Mean`](api/boost_histogram.html.md#boost_histogram.storage.Mean)
  * [`MultiCell`](api/boost_histogram.html.md#boost_histogram.storage.MultiCell)
    * [`MultiCell.accumulator`](api/boost_histogram.html.md#boost_histogram.storage.MultiCell.accumulator)
  * [`Storage`](api/boost_histogram.html.md#boost_histogram.storage.Storage)
    * [`Storage.accumulator`](api/boost_histogram.html.md#boost_histogram.storage.Storage.accumulator)
  * [`Unlimited`](api/boost_histogram.html.md#boost_histogram.storage.Unlimited)
    * [`Unlimited.accumulator`](api/boost_histogram.html.md#boost_histogram.storage.Unlimited.accumulator)
  * [`Weight`](api/boost_histogram.html.md#boost_histogram.storage.Weight)
  * [`WeightedMean`](api/boost_histogram.html.md#boost_histogram.storage.WeightedMean)
* [boost_histogram.tag](api/boost_histogram.html.md#module-boost_histogram.tag)
  * [`Locator`](api/boost_histogram.html.md#boost_histogram.tag.Locator)
    * [`Locator.NAME`](api/boost_histogram.html.md#boost_histogram.tag.Locator.NAME)
    * [`Locator.offset`](api/boost_histogram.html.md#boost_histogram.tag.Locator.offset)
  * [`Slicer()`](api/boost_histogram.html.md#boost_histogram.tag.Slicer)
  * [`at`](api/boost_histogram.html.md#boost_histogram.tag.at)
    * [`at.value`](api/boost_histogram.html.md#boost_histogram.tag.at.value)
  * [`loc`](api/boost_histogram.html.md#boost_histogram.tag.loc)
    * [`loc.value`](api/boost_histogram.html.md#boost_histogram.tag.loc.value)
  * [`rebin`](api/boost_histogram.html.md#boost_histogram.tag.rebin)
    * [`rebin.axis`](api/boost_histogram.html.md#boost_histogram.tag.rebin.axis)
    * [`rebin.axis_mapping()`](api/boost_histogram.html.md#boost_histogram.tag.rebin.axis_mapping)
    * [`rebin.edges`](api/boost_histogram.html.md#boost_histogram.tag.rebin.edges)
    * [`rebin.factor`](api/boost_histogram.html.md#boost_histogram.tag.rebin.factor)
    * [`rebin.group_mapping()`](api/boost_histogram.html.md#boost_histogram.tag.rebin.group_mapping)
    * [`rebin.groups`](api/boost_histogram.html.md#boost_histogram.tag.rebin.groups)
  * [`sum()`](api/boost_histogram.html.md#boost_histogram.tag.sum)
* [boost_histogram.typing](api/boost_histogram.html.md#module-boost_histogram.typing)
  * [`ArrayLike`](api/boost_histogram.html.md#boost_histogram.typing.ArrayLike)
  * [`AxisLike`](api/boost_histogram.html.md#boost_histogram.typing.AxisLike)
    * [`AxisLike.index()`](api/boost_histogram.html.md#boost_histogram.typing.AxisLike.index)
  * [`CppHistogram`](api/boost_histogram.html.md#boost_histogram.typing.CppHistogram)
  * [`Mean`](api/boost_histogram.html.md#boost_histogram.typing.Mean)
  * [`RebinProtocol`](api/boost_histogram.html.md#boost_histogram.typing.RebinProtocol)
    * [`RebinProtocol.axis_mapping()`](api/boost_histogram.html.md#boost_histogram.typing.RebinProtocol.axis_mapping)
  * [`Ufunc`](api/boost_histogram.html.md#boost_histogram.typing.Ufunc)
  * [`WeightedMean`](api/boost_histogram.html.md#boost_histogram.typing.WeightedMean)
  * [`WeightedSum`](api/boost_histogram.html.md#boost_histogram.typing.WeightedSum)
* [boost_histogram.view](api/boost_histogram.html.md#module-boost_histogram.view)
  * [`MeanView`](api/boost_histogram.html.md#boost_histogram.view.MeanView)
    * [`MeanView.count`](api/boost_histogram.html.md#boost_histogram.view.MeanView.count)
    * [`MeanView.value`](api/boost_histogram.html.md#boost_histogram.view.MeanView.value)
    * [`MeanView.variance`](api/boost_histogram.html.md#boost_histogram.view.MeanView.variance)
  * [`View`](api/boost_histogram.html.md#boost_histogram.view.View)
  * [`WeightedMeanView`](api/boost_histogram.html.md#boost_histogram.view.WeightedMeanView)
    * [`WeightedMeanView.sum_of_weights`](api/boost_histogram.html.md#boost_histogram.view.WeightedMeanView.sum_of_weights)
    * [`WeightedMeanView.sum_of_weights_squared`](api/boost_histogram.html.md#boost_histogram.view.WeightedMeanView.sum_of_weights_squared)
    * [`WeightedMeanView.value`](api/boost_histogram.html.md#boost_histogram.view.WeightedMeanView.value)
    * [`WeightedMeanView.variance`](api/boost_histogram.html.md#boost_histogram.view.WeightedMeanView.variance)
  * [`WeightedSumView`](api/boost_histogram.html.md#boost_histogram.view.WeightedSumView)
    * [`WeightedSumView.value`](api/boost_histogram.html.md#boost_histogram.view.WeightedSumView.value)
    * [`WeightedSumView.variance`](api/boost_histogram.html.md#boost_histogram.view.WeightedSumView.variance)
  * [`fields()`](api/boost_histogram.html.md#boost_histogram.view.fields)
  * [`make_getitem_property()`](api/boost_histogram.html.md#boost_histogram.view.make_getitem_property)

## Acknowledgements

This library was primarily developed by Henry Schreiner and Hans
Dembinski.

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.

# Indices and tables

* [Index](genindex.html.md)
* [Module Index](py-modindex.html.md)
* [Search Page](search.html.md)
