Metadata-Version: 2.0
Name: hep-spt
Version: 0.0.0.dev2
Summary: Provides statistical and plotting tools using general python packages, focused to High Energy Physics.
Home-page: UNKNOWN
Author: UNKNOWN
Author-email: UNKNOWN
License: UNKNOWN
Description-Content-Type: UNKNOWN
Keywords: physics hep statistics plotting
Platform: UNKNOWN
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pytest
Requires-Dist: scipy

=======
hep_spt
=======

.. image:: https://img.shields.io/travis/mramospe/hep_spt.svg
   :target: https://travis-ci.org/mramospe/hep_spt

.. image:: https://img.shields.io/badge/documentation-link-blue.svg
   :target: https://mramospe.github.io/hep_spt/

.. inclusion-marker-do-not-remove

The **High Energy Physics Statistics and Plotting Tools** package provides tools to work in **High Energy Physics** using general python packages.

Main points
===========

  * Statistical functions to work with Bayesian/Frequentist approaches.
  * Utilities to handle poissonian and/or weighted histograms.
  * Tools to handle `matplotlib <https://matplotlib.org/>`_ figures.

Considerations:
===============

  * Samples are usually preferred as structured `numpy.ndarray <https://docs.scipy.org/doc/numpy-1.13.0/reference/generated/numpy.ndarray.html>`_ objects.
  * Plotting functions and classes are designed to work with `matplotlib <https://matplotlib.org/>`_.
  * Statistical tools are built on top of the standard `scipy <https://www.scipy.org/>`_ package.

Installation:
=============

This package is available on PyPi, so just type:

.. code-block:: bash

   pip install hep-spt

To use the **latest development version**, clone the repository and install with `pip`:

.. code-block:: bash

   git clone https://github.com/mramospe/hep_spt.git
   pip install hep_spt


