Metadata-Version: 1.1
Name: order
Version: 0.1.1
Summary: Pythonic class collection that helps you structure external data from LHC / HEP experiments.
Home-page: https://github.com/riga/order
Author: Marcel Rieger
Author-email: python-order@googlegroups.com
License: MIT
Description-Content-Type: UNKNOWN
Description: |Build Status| |Documentation Status| |Package Status|
        
        If you're designing a high-energy physics analysis (e.g. with data
        recorded with an
        `LHC <https://home.cern/topics/large-hadron-collider>`__ experiment at
        `CERN <http://home.cern>`__), manual bookkeeping of external data can
        get complicated quite fast. *order* provides a Python class collection
        that helps you structuring
        
        -  analyses,
        -  MC campaigns,
        -  datasets,
        -  cross sections,
        -  channels,
        -  categories,
        -  systematics, and
        -  models for statistical inference.
        
        Getting started
        ~~~~~~~~~~~~~~~
        
        See the
        `intro.ipynb <https://github.com/riga/order/blob/master/examples/intro.ipynb>`__
        notebook for an introduction to the most important classes and an
        example setup of a small analysis.
        
        You can find the full `API documentation on
        readthedocs. <http://python-order.readthedocs.io>`__.
        
        Installation and dependencies
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Via `pip <https://pypi.python.org/pypi/order>`__:
        
        .. code:: bash
        
            pip install order
        
        Currently, the only dependencies of the core classes are
        `scinum <https://github.com/riga/scinum>`__ and
        `six <https://pypi.python.org/pypi/six>`__, which are also installed
        with the above command.
        
        Contributing
        ~~~~~~~~~~~~
        
        If you like to contribute, I'm happy to receive pull requests. Just make
        sure to add a new test cases and run them via:
        
        .. code:: bash
        
            > python -m unittest tests
        
        Testing
        '''''''
        
        In general, tests should be run for different environments:
        
        -  Python 2.7
        -  Python 3.5
        -  Python 3.6
        
        Docker
        ''''''
        
        To run tests in a docker container, do:
        
        .. code:: bash
        
            git clone https://github.com/riga/order.git
            cd order
        
            docker run --rm -v `pwd`:/root/order -w /root/order python:3.6 /bin/bash -c "\
                pip install -r requirements.txt; python -m unittest tests"
        
        Development
        ~~~~~~~~~~~
        
        -  Source hosted at `GitHub <https://github.com/riga/order>`__
        -  Report issues, questions, feature requests on `GitHub
           Issues <https://github.com/riga/order/issues>`__
        
        Authors
        ~~~~~~~
        
        -  `Marcel R. <https://github.com/riga>`__
        
        License
        ~~~~~~~
        
        The MIT License (MIT)
        
        Copyright (c) 2017 Marcel R.
        
        Permission is hereby granted, free of charge, to any person obtaining a
        copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be included
        in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
        OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
        CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
        TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
        SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        .. |Build Status| image:: https://travis-ci.org/riga/order.svg?branch=master
           :target: https://travis-ci.org/riga/order
        .. |Documentation Status| image:: https://readthedocs.org/projects/python-order/badge/?version=latest
           :target: http://python-order.readthedocs.org/en/latest/?badge=latest
        .. |Package Status| image:: https://badge.fury.io/py/order.svg
           :target: https://badge.fury.io/py/order
        
Keywords: physics,analysis,experiment,order,structure,database,lhc,cms,atlas,alice,lhcb
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
