Welcome to histpy's documentation!
==================================

The histpy library provides a :doc:`Histogram <api/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 <https://root.cern/manual/histograms>`_ 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 <https://docs.astropy.org/en/stable/units/index.html>`_, both for the histogram contents and the axis edges.
* Spherical coordinates axes, using the `HEALPix <https://healpix.sourceforge.io/>`_ grid.
* `Sparse <https://sparse.pydata.org/en/stable/>`_ contents
* I/O to/from `HDF5 <https://www.hdfgroup.org/solutions/hdf5/>`_ files.

See the :doc:`quick start tutorial <tutorials/quick-start>` to get started and continue to the :doc:`API <api/index>` 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


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   tutorials/quick-start.ipynb
   api/index