This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
===============================
Heppi (Hep Plotting Interface)
===============================

.. image:: https://img.shields.io/pypi/v/heppi.svg
:target: https://pypi.python.org/pypi/heppi

.. image:: https://img.shields.io/travis/yhaddad/heppi.svg
:target: https://travis-ci.org/yhaddad/heppi

.. image:: https://readthedocs.org/projects/heppi/badge/?version=latest
:target: https://readthedocs.org/projects/heppi/?badge=latest
:alt: Documentation Status


A High Energy Physics Plotting Interface

* Free software: ISC license
* Documentation: https://heppi.readthedocs.org.

Discription
-----------
``Heppi`` is a plotting interface written in pyROOT and uses json files as configuration file.
the plotcard systax is higly flexible allowing you to define different processes, variable, cuts
and selection categories.


installation
------------
* The recomended procedure to install ``Heppi`` is trough ``PyPI``
.. code-block::
pip install heppi

* For CERN users, you might need to install the package on your .local directory by adding ``--user`` option to the previous command.
.. code-block::
pip install heppi --user

* The dependencies will normaly be installed automatically.
* Since ``Heppi`` is based on pyROOT, ROOT env must be set

installation via Git:
~~~~~~~~~~~~~~~~~~~~~
* The alternative way to install Heppi is by cloning and building the project
.. code-block::
> git clone git@github.com:yhaddad/Heppi.git
> cd Heppi
> pip install dependencies --user
> make install-user

How to run
----------

Produce a plotcard
~~~~~~~~~~~~~~~~~~~
* ``Heppi`` allows to create your own plotcard using the makeplotcard script. You can run
.. code-block::
makeplotcard


Produce a stacked plots
~~~~~~~~~~~~~~~~~~~~~~~

* To run ``heepi`` plotmaker you have to run the script ``plot``
* you can print the options of the script by typing ``.\plot --help``
* you have to combine the trees using ``rootmerge.py`` script
* the commend I'm using is the follwing:

.. code-block::
./plot -s /dir/to/merged/trees --load plotcard.json --all

* if you want to print one variable in the plotcard you can replace the option ``--all`` by ``--variable`` or just ``-v`` followed by the name of the variable.
example :

.. code-block::
./plot -s /dir/to/merged/trees --load plotcard.json -v var1

Write a valid plotcard ?
~~~~~~~~~~~~~~~~~~~~~~~~

* Produce the plotcard using a processe.json files and input root file.
* The tree name must be specified

.. code-block:: bash
./makeplotcard.py --load /path/to/root/file.root \
--out plotcard.json \
--tree VBFMVADumper/*VBFDiJet

* the ``*`` will be replaced automatically by the remaining name of the tree found in the ``VBFMVADumper`` directory.
* This is for the use of .. _``flashgg``: https://github.com/cms-analysis/flashgg type dumper trees only, a more standard version will be pushed soon

Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2015-12-13)
------------------

* First release on PyPI.
Release History

Release History

2.1.0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.4

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting