Welcome to histpy’s documentation!

The histpy library provides a Histogram class which is, essentially, an array with axes attached defining the bin boundaries. The histpy library class is loosely based on ROOT’s histogram but using a more pythonic interface.

The histpy library supports:

  • Histograms with an arbitrary number of dimensions.

  • Numpy-like element indexing.

  • Multiple operations: projection, slicing, addition, multiplication, concatenation, rebinning, fitting, interpolation and plotting.

  • Tracking of under and overflow contents along each axes.

  • Weighted histograms.

  • Automatic error propagation.

  • Astropy’s units, both for the histogram contents and the axis edges.

  • Spherical coordinates axes, using the HEALPix grid.

  • Sparse contents

  • I/O to/from HDF5 files.

See the quick start tutorial to get started and continue to the API documentation for more details.

Installation

Run:

pip install histpy

Alternatively, developers can get a working version with:

git clone git@gitlab.com:burstcube/histpy.git
cd  histpy
python setup.py develop

Contents: