Metadata-Version: 2.1
Name: coffea
Version: 0.5.8
Summary: Tools for doing Collider HEP style analysis with columnar operations
Home-page: https://github.com/CoffeaTeam/coffea
Author: Lindsey Gray (Fermilab)
Author-email: lagray@fnal.gov
Maintainer: Lindsey Gray (Fermilab)
Maintainer-email: lagray@fnal.gov
License: BSD 3-clause
Download-URL: https://github.com/CoffeaTeam/coffea/releases
Platform: Any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Dist: awkward (>=0.8.4)
Requires-Dist: matplotlib (>=3)
Requires-Dist: numba (>=0.43.1)
Requires-Dist: numpy (>=1.16.0)
Requires-Dist: scipy (>=1.1.0)
Requires-Dist: uproot-methods (>=0.4.3)
Requires-Dist: uproot (>=3.4.5)
Requires-Dist: tqdm
Requires-Dist: lz4
Requires-Dist: cloudpickle
Requires-Dist: futures ; python_version == "2.7"
Provides-Extra: parsl
Requires-Dist: parsl (>=0.7.2) ; extra == 'parsl'
Requires-Dist: cloudpickle ; extra == 'parsl'
Requires-Dist: lz4 ; extra == 'parsl'
Provides-Extra: spark
Requires-Dist: pyspark (>=2.4.1) ; extra == 'spark'
Requires-Dist: pyarrow ; extra == 'spark'
Requires-Dist: cloudpickle ; extra == 'spark'
Requires-Dist: lz4 ; extra == 'spark'
Requires-Dist: jinja2 ; extra == 'spark'
Requires-Dist: pandas ; extra == 'spark'

.. inclusion-marker-1-5-do-not-remove

coffea is currently organized into several sub-modules with specific purposes.


1) analysis_objects - This package contains definitions of physics objects casted in the language of JaggedArrays

2) arrays - Another take on making analysis objects with directly decorated LorentzVector objects instead of wrapped LorentzVectors.

3) hist - A well-featured histogramming and plotting sub-package.

4) jetmet_tools - CMS-specific tools for correcting Jets and Missing Energy

5) lookup_tools - This package manages importing corrections and scale factors, and provides a unified interface for evaluating those corrections on physics objects.

6) lumi tools - A CMS-specific package for parsing luminosity database files to derive integrated luminosity and good run lists.

7) processor - An interface for defining and running analyses in a portable way across a variety of scale-out mechanisms.

8) striped - This package defines transformations from the raw striped database into JaggedArrays and JaggedCandidateArrays, but is somewhat deprecated.

For further information please see the complete package index in our `documentation <https://coffeateam.github.io/coffea/>`_.

.. inclusion-marker-2-do-not-remove

Installation
============

Install coffea like any other Python package:

.. code-block:: bash

    pip install coffea

or similar (use ``sudo``, ``--user``, ``virtualenv``, or pip-in-conda if you wish).

Strict dependencies:
====================

- `Python <http://docs.python-guide.org/en/latest/starting/installation/>`__ (2.7+, 3.6+)

The following are installed automatically when you install uproot with pip:

- `numpy <https://scipy.org/install.html>`__ (1.15+)
- `awkward-array <https://pypi.org/project/awkward>`__ to manipulate data from non-flat TTrees, such as jagged arrays (`part of Scikit-HEP <https://github.com/scikit-hep/awkward-array>`__)
- `uproot-methods <https://pypi.org/project/uproot-methods>`__ to allow expressions of things as lorentz vectors
- `numba <https://numba.pydata.org/>`__ just-in-time compilation of python functions
- ``scipy`` for statistical functions
- ``matplitlib`` as a plotting backend
- ``uproot`` for interacting with ROOT files
- ``tqdm``

