https://github.com/agoose77/coffea

Basic tools and wrappers for enabling not-too-alien syntax when running columnar Collider HEP analysis.

https://github.com/agoose77/coffea

Repository

Basic tools and wrappers for enabling not-too-alien syntax when running columnar Collider HEP analysis.

README.rst

coffea - Columnar Object Framework For Effective Analysis
=========================================================

.. image:: https://zenodo.org/badge/159673139.svg
   :target: https://zenodo.org/badge/latestdoi/159673139

.. image:: https://github.com/CoffeaTeam/coffea/workflows/CI%2FCD/badge.svg
    :target: https://github.com/CoffeaTeam/coffea/actions?query=workflow%3ACI%2FCD+event%3Aschedule+branch%3Amaster

.. image:: https://codecov.io/gh/CoffeaTeam/coffea/branch/master/graph/badge.svg?event=schedule
    :target: https://codecov.io/gh/CoffeaTeam/coffea

.. image:: https://badge.fury.io/py/coffea.svg
    :target: https://badge.fury.io/py/coffea

.. image:: https://img.shields.io/pypi/dm/coffea.svg
    :target: https://img.shields.io/pypi/dm/coffea

.. image:: https://img.shields.io/conda/vn/conda-forge/coffea.svg
    :target: https://anaconda.org/conda-forge/coffea

.. image:: https://badges.gitter.im/CoffeaTeam/coffea.svg
    :target: https://gitter.im/coffea-hep

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/CoffeaTeam/coffea/master?filepath=binder/

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

Basic tools and wrappers for enabling not-too-alien syntax when running columnar Collider HEP analysis.

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

coffea is a prototype package for pulling together all the typical needs
of a high-energy collider physics (HEP) experiment analysis using the scientific
python ecosystem. It makes use of `uproot `_
and `awkward-array `_ to provide an
array-based syntax for manipulating HEP event data in an efficient and numpythonic
way. There are sub-packages that implement histogramming, plotting, and look-up
table functionalities that are needed to convey scientific insight, apply transformations
to data, and correct for discrepancies in Monte Carlo simulations compared to data.

coffea also supplies facilities for horizontally scaling an analysis in order to reduce
time-to-insight in a way that is largely independent of the resource the analysis
is being executed on. By making use of modern *big-data* technologies like
`Apache Spark `_,  `parsl `_,
`Dask `_ , and `Work Queue `_,
it is possible with coffea to scale a HEP analysis from a testing
on a laptop to: a large multi-core server, computing clusters, and super-computers without
the need to alter or otherwise adapt the analysis code itself.

coffea is a HEP community project collaborating with `iris-hep `_
and is currently a prototype. We welcome input to improve its quality as we progress towards
a sensible refactorization into the scientific python ecosystem and a first release. Please
feel free to contribute at our `github repo `_!

.. 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).
For more details, see the `Installing coffea `_ section of the documentation.

Strict dependencies
===================

- `Python `__ (3.8+)

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

- `numpy `__ (1.22+);
- `uproot `__ for interacting with ROOT files and handling their data transparently;
- `awkward-array `__ to manipulate complex-structured columnar data, such as jagged arrays;
- `numba `__ just-in-time compilation of python functions;
- `scipy `__ for many statistical functions;
- `matplotlib `__ as a plotting backend;
- and other utility packages, as enumerated in ``pyproject.toml``.

.. inclusion-marker-3-do-not-remove

Documentation
=============
All documentation is hosted at https://coffeateam.github.io/coffea/

Citation
========
If you would like to cite this code in your work, you can use the zenodo DOI indicated in ``CITATION.cff``, or the `latest DOI `__. You may also cite the proceedings:

- "N. Smith et al 2020 EPJ Web Conf. 245 06012"
- "L. Gray et al 2023 J. Phys.: Conf. Ser. 2438 012033"

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Gray"
  given-names: "Lindsey"
  affiliation: "Fermilab"
  orcid: "https://orcid.org/0000-0002-6408-4288"
  email: "Lindsey.Gray@cern.ch"
- family-names: "Smith"
  given-names: "Nicholas"
  affiliation: "Fermilab"
  orcid: "https://orcid.org/0000-0002-0324-3054"
  email: "nick.smith@cern.ch"
- family-names: "Novak"
  given-names: "Andrzej"
  affiliation: "RWTH Aachen"
  orcid: "https://orcid.org/0000-0002-0389-5896"
- family-names: "Fackeldey"
  given-names: "Peter"
  affiliation: "RWTH Aachen University"
  orcid: "https://orcid.org/0000-0003-4932-7162"
  email: "peter.fackeldey@rwth-aachen.de"
- family-names: "Tovar"
  given-names: "Benjamin"
  affiliation: "University of Notre Dame"
  orcid: "https://orcid.org/0000-0002-5294-2281"
  email: "btovar@nd.edu"
- family-names: "Chen"
  given-names: "Yi-Mu"
  affiliation: "University of Maryland, College Park"
  orcid: "https://orcid.org/0000-0002-5795-4783"
  email: "yi-mu.chen@cern.ch"
- family-names: "Watts"
  given-names: "Gordon"
  affiliation: "University of Washington"
  orcid: "https://orcid.org/0000-0002-0753-7308"
  email: "gwatts@uw.edu"
- family-names: "Krommydas"
  given-names: "Iason"
  affiliation: "Rice University"
  orcid: "https://orcid.org/0000-0001-7849-8863"
  email: "ik23@rice.edu"
title: "coffea"
version: 0.7.21
doi: 10.5281/zenodo.7733568
date-released: 2023-03-14
url: "https://github.com/CoffeaTeam/coffea"

GitHub Events