# boost_histogram

> Python bindings for Boost.Histogram, a fast multi-dimensional histogram library, with a NumPy-like API and Unified Histogram Interface support.


2020-2026, Henry Schreiner, Hans Dembinski

## Pages

- [Welcome to boost-histogram’s documentation!](index.html.md): boost-histogram is a Python package for fast, multi-dimensional histograms, with Python bindings for the Boost.Histogram C++ library.
- [Installation](user-guide/installation.html.md): Boost-histogram (source) is
- [Quickstart](user-guide/quickstart.html.md): All of the examples will assume the following import:
- [Histogram](user-guide/histogram.html.md): The Histogram object is the core of boost-histogram.
- [Axes](user-guide/axes.html.md): In boost-histogram, a histogram is collection of Axis objects and a
- [Storages](user-guide/storage.html.md): There are several storages to choose from. To select a storage, pass the
- [Accumulators](user-guide/accumulators.html.md): All accumulators can be filled like a histogram. You just call `.fill` with
- [Using Transforms](user-guide/transforms.html.md): The boost-histogram library provides a powerful transform system on Regular axes that allows
- [Indexing](user-guide/indexing.html.md): Boost-histogram implements the UHI indexing protocol. You can read more about it on the UHI Indexing...
- [Plotting](user-guide/plotting.html.md): Boost-histogram does not contain plotting functions - this is outside of the
- [Analyses examples](user-guide/analyses.html.md): Taken together, the flexibility in axes and the tools to easily sum over
- [NumPy compatibility](user-guide/numpy.html.md): You can access the storage of any Histogram using `.view()`, see
- [Subclassing (advanced)](user-guide/subclassing.html.md): Subclassing boost-histogram components is supported, but requires a little extra care to ensure the ...
- [Comparison with Boost.Histogram](user-guide/comparison.html.md): `boost-histogram` was based on the C++ library Boost.Histogram. In most ways,
- [Simple Example](notebooks/SimpleExample.html.md): Let’s try some basic functionality of boost-histogram:
- [MultiCell histograms](notebooks/MultiCellExample.html.md): Usually, one has to deal with `n` events to histogram by sorting each event into bins based on some ...
- [Threaded Fills](notebooks/ThreadedFills.html.md): This notebook explores parallel filling by hand (not using the `threads=` argument).
- [Performance Comparison](notebooks/PerformanceComparison.html.md): We will compare boost-histogram to numpy.
- [XArray Example](notebooks/xarray.html.md): To run this example, an environment.yml similar to this one could be used:
- [Using boost-histogram](notebooks/BoostHistogramHandsOn.html.md): Let’s start with the basics. We will create a histogram using boost-histogram and fill it.
- [Contributing](contributing.html.md): See the Scikit-HEP Developer introduction for a
- [Support](support.html.md): If you are stuck with a problem using Boost-histogram, please do get in touch at our
- [Changelog](changelog.html.md): - `MultiCell` now requires a cell count of one or more; the argument has no default by @henryiii in ...
- [Modules](api/modules.html.md): * boost_histogram
- [boost_histogram](api/boost_histogram.html.md): Bases: `Generic`[`S`]
- [Simple usage](banner_slides.html.md): Build with: