histbook 1.0.4

Versatile, high-performance histogram toolkit for Numpy.

histbook computes histograms from Numpy arrays. It differs from most other histogramming tools in that its histograms are primarily tables of numbers, rather than display graphics. Histograms can be filled and refilled iteratively through a large dataset, or in parallel and later combined with addition*. Histograms have arbitrarily many dimensions with convenient methods for selecting, rebinning, and projecting into lower-dimensional spaces.

Axis dimensions are managed by algebraic expressions, rather than string labels or index positions, so they are computable: an axis named x + y requires two Numpy arrays, x and y, which will be added before filling the histogram. Expressions in different axes or different histograms in the same “book” (a collection of named histograms) are computed in an optimized way, reusing subexpressions wherever possible for quicker filling without giving up clarity.

Histogram data may be exported to a variety of formats, such as Pandas, ROOT, and HEPData. It can also be plotted with Vega-Lite, which makes short work of projecting many dimensions of data as overlays and trellises.

(*In this respect, histbook is like histogramming packages developed for particle physics, from CERN HBOOK in the 1970’s (name similarity intended) to modern-day ROOT.)

Installation

Install histbook like any other Python package:

pip install histbook --user

or similar (use sudo, virtualenv, or conda if you wish).

Strict dependencies:

• Python (2.7+, 3.4+)

• Numpy (1.8.0+)

• meta

Recommended dependencies:

• Pandas for more convenient programmatic access to bin contents

• vega to view plots in a Jupyter notebook or vegascope to view them in a browser window without Jupyter.

• ROOT to analyze histograms in a complete statistical toolkit

• uproot to access ROOT files without the full ROOT framework

Tutorial

See the project homepage for a tutorial.

Interactive tutorial

Run this tutorial on Binder.

Reference documentation

• Histograms

• Books of histograms

• Axis descriptors