Metadata-Version: 1.1
Name: Heppi
Version: 0.1
Summary: High Energy Physics Plotting Interface
Home-page: https://github.com/yhaddad/Heppi
Author: Yacine Haddad
Author-email: yhaddad@cern.ch
License: ISCL
Download-URL: https://github.com/yhaddad/Heppi/tarball/0.1
Description: ===============================
        Heppi
        ===============================
        
        .. 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.
        
        How to run
        ----------
        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
        
        installation
        ------------
        * Run the setup script to install the dependencies: ``python setup.py develop --user`` or run : ``pip install --user jsmin termcolor progressbar jsonmerge``, both ways works on lxplus.
        * ROOT env must be set, I recomend to setup CMSSW env before runnning the previous commands
        
        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.
        
Keywords: Heppi,heppi
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
