jetgo

Jet Event Toolkit for Generator-level Observables.

jetgo generates collider events with pythia8mc, clusters the particles into jets with fastjet, tags each jet with the color charge of the parton that initiated it, and writes the observables out. You define the simulator, the observables and the tagger, jetgo does the rest.

pip install jetgo[pythia]

PYTHIA8 is an optional dependency, because the pythia8mc wheels are Linux-only. Plain pip install jetgo works everywhere and gives you every observable and tagger; only event generation needs the extra.

There are two ways to get PYTHIA8, and jetgo accepts either:

The wheel.

The [pythia] extra above pulls in pythia8mc, the PyPI distribution of PYTHIA’s own Python bindings. Nothing to compile, but the wheels are built for Linux only.

Your own build.

Compile PYTHIA8 with its Python interface enabled, following the PYTHIA manual, so that import pythia8 works. This is the route on macOS and Windows, and the one to take if you need a specific PYTHIA version or your own patches.

Guides

• Quickstart
  • The three pieces
  • A first run
  • Why the bin edges are required
  • Splitting by flavor
  • What the output file holds
  • Reading it back
• Writing your own observable
  • The contract
  • Two rules worth internalizing
  • A worked example
  • Reading a particle’s identity
• Writing your own tagger
  • Comparing taggers
  • The shipped tagger

Reference

• API reference
  • Simulation
  • Observables
  • Taggers
  • Kinematics

Indices

• Index

• Module Index