The Rivet MC analysis framework

Rivet is a C++ and Python framework for preservation and reinterpretation of particle collider analyses, suitable for comparison with Monte Carlo event generator predictions, and an enabler of physics model development, validation, and optimisation in both Standard Model and BSM.

Rivet is built on the dual concepts of analyses – routines which implement published experiment analyses – and projections – routines which compute observables from MC event records. It is designed to be efficient via automatic caching of projection results for each event, and very "physicist friendly" with analysis codes containing minimal boilerplate code and maximum physics.

Key classes

• Analysis: base for implementation of analysis logic
• SimpleAnalysis: base for implementation of simplified analysis logic
• Particle: representation of (meta)particles
• Jet: representation of recursively clustered particle jets
• FourMomentum: a 4-momentum object
• Event: container of all particles
• ParticleBase: core functionality for particles and jets

Key projections

• ParticleFinder: base class for retrieving particles matching cuts
• FinalState: retrieve all final-state particles
• PromptFinalState: retrieve FS particles not from hadron decays
• LeptonFinder: finder of "physical" bare leptons plus ~collinear photons
• TauFinder: finder of "physical" bare leptons plus ~colinear photons
• UnstableParticles: retrieve all physical, decayed particles
• HeavyHadrons: retrieve decayed heavy-flavour hadrons

• JetFinder: base class for jet reconstruction
• FastJets: interface to the FastJet clustering package

• METFinder: base class for missing-momentum
• MissingMomentum: fiducial definition of momentum imbalances

• PartonicTops: retrieve final partonic top quarks, if recorded (warning!)

Detector projections

• SmearedParticles: detector efficiency and smearing functions for particles
• SmearedJets: detector efficiency and smearing functions for jets
• SmearedMET: detector efficiency and smearing functions for missing ET

Key tools

• Modules
• Filtering utilities
• Container utilities
• String utilities
• PID utilities

Advanced classes (for API embedding)

• AnalysisHandler: coordinator of Analysis objects in a Run
• AnalysisInfo: direct access to analysis metadata (most also via Analysis)
• Run: aggregator of multiple incoming event files into a single stream

For more information, please see the documentation via https://rivet.hepforge.org/