PocketCoffea

Introduction

PocketCoffea is a slim analysis framework based on Coffea for CMS NanoAOD events.

The goal of the framework is to define an HEP analysis in a declarative way where possible (with a well defined configuration file), and with python code where customization is needed (by defining new coffea processors).

PocketCoffea defines a customizable structure to process NanoAOD events and define weights, categories, histograms. This is done thanks to a BaseProcessor class which defines a workflow of operations to go from NanoAOD to histograms. The user can customize the process from the confguration file or by redefining well-defined steps in the workflow.

Tip

• If you wish to jump into practice have a look at the full analyses example.

• Installation instructions are available here

• If you want a broader introduction to the components of PocketCoffea have a look at Concepts.

• Looking for the configuration manual? Configuration

• Changelog
• Installation
• Running the analysis
• Executors
• Full analysis examples
• Plotting
• Concepts
• Configuration
• Parameters
• Datasets handling
• Analysis performance
• API Reference Guide
  • pocket_coffea
    • pocket_coffea package
      • pocket_coffea.lib package
      • pocket_coffea.parameters package
        • pocket_coffea.parameters.jec package
      • pocket_coffea.utils package
      • pocket_coffea.workflows package