API Reference Guide

Coffea: a column object framework for effective analysis.

When executing

>>> import coffea

a subset of the full coffea package is imported into the python environment. Some packages must be imported explicitly, so as to avoid importing unnecessary and/or heavy dependencies. Below lists the packages available in the coffea namespace.

coffea.analysis_tools	Tools of general use for columnar analysis
coffea.btag_tools	BTag tools: CMS analysis-level b-tagging corrections and uncertainties
coffea.dataset_tools
coffea.jetmet_tools	JetMET tools: CMS analysis-level jet corrections and uncertainties
coffea.lookup_tools	Lookup tools
coffea.lumi_tools	Tools to parse CMS luminosity non-event data
coffea.ml_tools	Tools to interface with various ML inference services
coffea.nanoevents	NanoEvents and helpers
coffea.nanoevents.methods.base	Basic NanoEvents and NanoCollection mixins
coffea.nanoevents.methods.candidate	Physics object candidate mixin
coffea.nanoevents.methods.nanoaod	Mixins for the CMS NanoAOD schema
coffea.nanoevents.methods.vector	2D, 3D, and Lorentz vector class mixins
coffea.processor	A framework for analysis scale-out
coffea.util	Utility functions