Overview

Symbolica documentation for getting started, symbolic expressions, numerical evaluation, pattern matching, and APIs in Python and Rust.

HEPkit

High-energy physics tools for symbolic and numerical calculations.

Models, Feynman diagrams, generation, CFFs, tensor reduction, and kinematics are available directly in this namespace, for example hepkit.FeynmanDiagram. hepkit.oneloop provides symbolic one-loop reduction, with scalar master evaluation available in native builds. Exact parametric and Laporta IBP solving through hepkit.IBPFamily is available in native and Pyodide builds.

Classes

Amplitude A coherent sum of amputated, unintegrated Feynman-diagram operators
AmplitudeError Invalid amplitude, conjugation, or external-state sum.
AmplitudeLeg One physical external state of a symbolic amplitude.
Axis A Cartesian axis used to specify spatial rotations.
Boost A proper Lorentz boost specified by a three-velocity beta
CancellationToken A thread-safe signal for cancelling a long diagram-generation job
CffError Failure while constructing a Cross-Free Family representation.
CffOrientation One acyclic energy-flow orientation in a CFF representation
CffReport Generation counts for a CFF representation
CffRepresentation A loop-energy integral in the cross-free family (CFF) representation
CffSurfaceGroup Equivalent energy surfaces and their maximum simultaneous pole order.
ClusteringResult The selected jets from one clustering operation
Coupling A coupling coefficient associated with interaction vertices
CrossFreeFamily One cross-free family of denominator surfaces in a CFF orientation
CutPartition A separating topology partition, independent of physical final-state cuts
CutPropagator An oriented generalized cut distribution for a possibly raised propagator
DiagramCut A generated physical final-state cut; each side retains its physics metadata.
DiagramCutSide One amplitude region of a physical cut, with generation metadata.
DiagramEdge A particle propagator joining two vertices in a Feynman diagram
DiagramError Invalid Feynman-diagram topology, annotation, or model reference.
DiagramGroup Diagrams whose numerators are related by known scalar factors
DiagramHalfEdge A particle-line endpoint using the diagram’s native half-edge numbering.
DiagramStyle Particle and momentum presentation for Feynman diagrams.
DiagramThresholdCandidate A topology threshold partition, independent of the requested physical final state.
DiagramVertex An interaction point in a Feynman diagram
EnergySurface A stored affine energy denominator in a CFF or LTD representation
EvaluatedValues Numerical values returned by a custom model evaluator
EvaluationRequest The complete input supplied to a custom model evaluator
FeynkitError Base exception for native HEP operations.
FeynmanDiagram A generated or imported Feynman diagram, with particles, momenta and Feynman rules
FormFactor A momentum-dependent form factor referenced by interaction rules
FourMomentum A relativistic four-momentum in (energy, px, py, pz) order
GenerationError Invalid process configuration or Feynman-diagram generation failure.
GenerationProgress A progress snapshot delivered on the Python thread running generation
GenerationReport Counts and completion status from a diagram-generation run
GenerationResult Feynman diagrams and diagnostics produced for one process
GroupMember One diagram and its numerator ratio inside a grouped result
Helicity A spin projection along a particle’s direction of motion
IBPCertificate Evidence returned by IBPSolution.certify; no public constructor
IBPFamily Find exact integration-by-parts (IBP) relations for a complete integral family
IBPRule One solved IBP identity, with its domain of validity
IBPSolution Rules, unresolved integrals and statistics returned by an IBP search
IntegralFamily An ordered set of inverse propagators sharing loop momenta and external kinematics
IntegralFamilyError Invalid loop-integral family, dependent propagators, or incomplete scalar-product basis.
IntegralMapping A verified real loop-momentum shift and propagator embedding
Jet A reconstructed collider jet and its input-particle constituents
JetAlgorithm A sequential-recombination algorithm for collider jet clustering
JetDefinition A generalized-kT jet definition for sequential recombination
Kinematics Scoped symbolic scalar products and two-to-two Mandelstam kinematics
KinematicsError Invalid Lorentz transformation, momentum, or jet-clustering request.
LoadedModel A normalized model, its parameter card, and its loading diagnostics
LoopMomentumBasis A consistent routing of independent loop and external momenta
LorentzStructure A reusable spin-dependent tensor structure in an interaction rule
LtdReport Generation counts for an LTD representation
LtdRepresentation A scalar loop-energy integral in the loop-tree duality (LTD) representation
LtdResidue One retained signed residue in an LTD representation
Model A loaded particle model ready for diagram generation
ModelError Invalid particle-model data or model operation.
ModelExpression A named symbolic expression awaiting numerical model evaluation
ModelFunction A named helper function used by model expressions
MomentumSignature Integer coefficients expressing one edge momentum in a chosen basis
NumeratorGrouping Choose cross-diagram numerator grouping.
OnShellEnergy A symbolic on-shell energy shared by CFF and LTD
Parameter A numerical or symbolic parameter in a particle-physics model
ParameterCard Mutable external parameter values for a particle model
ParameterNature Whether a model parameter is supplied externally or derived internally.
ParameterType Whether a model parameter is real-valued or complex-valued.
Particle A particle species in a loaded interaction model
ParticleSelector A model-independent way to identify an external particle
Process A scattering or decay process to pass to the diagram generator
Propagator A particle propagator with symbolic numerator and denominator
PropagatorMapping A formal propagator permutation determined from Symanzik polynomials
Rotation A spatial rotation acting on three- and four-momenta
SelfEnergyFilterOptions Configure rejection of self-energy subgraphs by mass category.
SnailFilterOptions Configure rejection of zero-momentum snail subgraphs.
SquaredAmplitude A coherent amplitude square with independent ket and bra tensor indices
Subgraph A physics region retaining its immutable original Feynman diagram
SurfaceFactor A signed denominator factor referring to a stored energy surface
SurfacePair The two linear factors of an uncut propagator at an LTD residue
Symbols Canonical expression heads owned by diagrams and imported models
TadpoleFilterOptions Configure rejection of tadpoles by the mass of their attachment.
TensorReducer Project Lorentz-tensor integrands onto Spenso invariants
TensorReductionError Failure while parsing or reducing a Lorentz tensor.
ThreeMomentum A Cartesian spatial momentum (px, py, pz)
TraversalTree A native DFS or BFS result retaining the immutable physics diagram.
UfoLoadDiagnostics Provenance, options, and entity counts from loading a UFO model
UfoLoadError Failure while importing or normalizing a UFO model.
UfoLoader Load and normalize a Universal FeynRules Output model
VertexRule An interaction vertex rule from a particle model
Wavefunction A fixed numerical external state in GammaLoop’s MadGraph phase convention