Symbols

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

`Symbols`

class Symbols

Canonical expression heads owned by diagrams and imported models.

Tensor and representation vocabulary belongs to symbolica.community.tensor. Symbols are constructed on demand so importing the module leaves time to set a license key. Use these references for diagram patterns and momentum construction without depending on internal namespaces. External and loop momenta belong to Kinematics. Model parameters and couplings belong to their model; obtain those through model.parameter(name).symbol or model.coupling(name).symbol instead.

Examples

from symbolica.community import hepkit as hep
Q = hep.Symbols.edge_momentum()
edge_momentum = Q(0)
mass = hep.Model.standard_model().particle("e-").mass

Methods

Name	Description
`denominator`	Tagged propagator denominator head; its fourth argument is the inverse denominator.
`dimension`	Lorentz dimension used by generated diagram expressions.
`edge_momentum`	Momentum family indexed by graph edge.
`half_edge`	Half-edge index family used to match external tensor slots.
`model_conjugate`	Complex-conjugation helper used in imported model formulas.
`polarization`	Vector polarization wavefunction head.
`polarization_conjugate`	Conjugated vector polarization wavefunction head.
`ufo_index`	Index placeholder head in model propagator definitions.
`ufo_metric`	Metric head in model propagator definitions.
`ufo_momentum`	Momentum head in model propagator definitions.

`denominator`

Symbols.denominator() -> Expression

Tagged propagator denominator head; its fourth argument is the inverse denominator.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.denominator()

`dimension`

Symbols.dimension() -> Expression

Lorentz dimension used by generated diagram expressions.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.dimension()

`edge_momentum`

Symbols.edge_momentum() -> Expression

Momentum family indexed by graph edge.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.edge_momentum()

`half_edge`

Symbols.half_edge() -> Expression

Half-edge index family used to match external tensor slots.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.half_edge()

`model_conjugate`

Symbols.model_conjugate() -> Expression

Complex-conjugation helper used in imported model formulas.

Examples

from symbolica.community import hepkit as hep
model = hep.Model.standard_model()
conjugate = hep.Symbols.model_conjugate()(model.parameter("CKM1x1").symbol)

`polarization`

Symbols.polarization() -> Expression

Vector polarization wavefunction head.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.polarization()

`polarization_conjugate`

Symbols.polarization_conjugate() -> Expression

Conjugated vector polarization wavefunction head.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.polarization_conjugate()

`ufo_index`

Symbols.ufo_index() -> Expression

Index placeholder head in model propagator definitions.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.ufo_index()

`ufo_metric`

Symbols.ufo_metric() -> Expression

Metric head in model propagator definitions.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.ufo_metric()

`ufo_momentum`

Symbols.ufo_momentum() -> Expression

Momentum head in model propagator definitions.

Examples

from symbolica.community import hepkit as hep
reference = hep.Symbols.ufo_momentum()