quantum_numbers

quantum_numbers#

import qrules.quantum_numbers

Definitions used internally for type hints and signatures.

qrules is strictly typed (enforced through mypy). This module bundles structures and definitions that don’t serve as data containers but only as type hints. EdgeQuantumNumbers and NodeQuantumNumbers are the main structures and serve as a bridge between the particle and the conservation_rules module.

class Parity(value: int | Parity)[source]#

Bases: object

value: Literal[-1, 1][source]#
class EdgeQuantumNumbers[source]#

Bases: object

Definition of quantum numbers for edges.

This class defines the types that are used in the conservation_rules, for instance in additive_quantum_number_rule. You can also create data classes (see attrs.define()) with data members that are typed as the data members of EdgeQuantumNumbers (see for example HelicityParityEdgeInput) and use them in conservation rules that satisfy the appropriate rule protocol (see ConservationRule, EdgeQNConservationRule).

pid = qrules.quantum_numbers.EdgeQuantumNumbers.pid[source]#
mass = qrules.quantum_numbers.EdgeQuantumNumbers.mass[source]#
width = qrules.quantum_numbers.EdgeQuantumNumbers.width[source]#
spin_magnitude = qrules.quantum_numbers.EdgeQuantumNumbers.spin_magnitude[source]#
spin_projection = qrules.quantum_numbers.EdgeQuantumNumbers.spin_projection[source]#
charge = qrules.quantum_numbers.EdgeQuantumNumbers.charge[source]#
isospin_magnitude = qrules.quantum_numbers.EdgeQuantumNumbers.isospin_magnitude[source]#
isospin_projection = qrules.quantum_numbers.EdgeQuantumNumbers.isospin_projection[source]#
strangeness = qrules.quantum_numbers.EdgeQuantumNumbers.strangeness[source]#
charmness = qrules.quantum_numbers.EdgeQuantumNumbers.charmness[source]#
bottomness = qrules.quantum_numbers.EdgeQuantumNumbers.bottomness[source]#
topness = qrules.quantum_numbers.EdgeQuantumNumbers.topness[source]#
baryon_number = qrules.quantum_numbers.EdgeQuantumNumbers.baryon_number[source]#
electron_lepton_number = qrules.quantum_numbers.EdgeQuantumNumbers.electron_lepton_number[source]#
muon_lepton_number = qrules.quantum_numbers.EdgeQuantumNumbers.muon_lepton_number[source]#
tau_lepton_number = qrules.quantum_numbers.EdgeQuantumNumbers.tau_lepton_number[source]#
parity = qrules.quantum_numbers.EdgeQuantumNumbers.parity[source]#
c_parity = qrules.quantum_numbers.EdgeQuantumNumbers.c_parity[source]#
g_parity = qrules.quantum_numbers.EdgeQuantumNumbers.g_parity[source]#
EdgeQuantumNumber#

Type hint for quantum numbers of edges

alias of pid | mass | width | spin_magnitude | spin_projection | charge | isospin_magnitude | isospin_projection | strangeness | charmness | bottomness | topness | baryon_number | electron_lepton_number | muon_lepton_number | tau_lepton_number | parity | c_parity | g_parity

EdgeQuantumNumberTypes = type[qrules.quantum_numbers.EdgeQuantumNumbers.pid] | type[qrules.quantum_numbers.EdgeQuantumNumbers.mass] | type[qrules.quantum_numbers.EdgeQuantumNumbers.width] | type[qrules.quantum_numbers.EdgeQuantumNumbers.spin_magnitude] | type[qrules.quantum_numbers.EdgeQuantumNumbers.spin_projection] | type[qrules.quantum_numbers.EdgeQuantumNumbers.charge] | type[qrules.quantum_numbers.EdgeQuantumNumbers.isospin_magnitude] | type[qrules.quantum_numbers.EdgeQuantumNumbers.isospin_projection] | type[qrules.quantum_numbers.EdgeQuantumNumbers.strangeness] | type[qrules.quantum_numbers.EdgeQuantumNumbers.charmness] | type[qrules.quantum_numbers.EdgeQuantumNumbers.bottomness] | type[qrules.quantum_numbers.EdgeQuantumNumbers.topness] | type[qrules.quantum_numbers.EdgeQuantumNumbers.baryon_number] | type[qrules.quantum_numbers.EdgeQuantumNumbers.electron_lepton_number] | type[qrules.quantum_numbers.EdgeQuantumNumbers.muon_lepton_number] | type[qrules.quantum_numbers.EdgeQuantumNumbers.tau_lepton_number] | type[qrules.quantum_numbers.EdgeQuantumNumbers.parity] | type[qrules.quantum_numbers.EdgeQuantumNumbers.c_parity] | type[qrules.quantum_numbers.EdgeQuantumNumbers.g_parity]#

Type-Union for accessing the keys of the dicts in EdgeSettings

class NodeQuantumNumbers[source]#

Bases: object

Definition of quantum numbers for interaction nodes.

l_magnitude = qrules.quantum_numbers.NodeQuantumNumbers.l_magnitude[source]#
l_projection = qrules.quantum_numbers.NodeQuantumNumbers.l_projection[source]#
s_magnitude = qrules.quantum_numbers.NodeQuantumNumbers.s_magnitude[source]#
s_projection = qrules.quantum_numbers.NodeQuantumNumbers.s_projection[source]#
parity_prefactor = qrules.quantum_numbers.NodeQuantumNumbers.parity_prefactor[source]#
NodeQuantumNumber#

Type hint for quantum numbers of interaction nodes.

alias of l_magnitude | l_projection | s_magnitude | s_projection | parity_prefactor

NodeQuantumNumberTypes = type[qrules.quantum_numbers.NodeQuantumNumbers.l_magnitude] | type[qrules.quantum_numbers.NodeQuantumNumbers.l_projection] | type[qrules.quantum_numbers.NodeQuantumNumbers.s_magnitude] | type[qrules.quantum_numbers.NodeQuantumNumbers.s_projection] | type[qrules.quantum_numbers.NodeQuantumNumbers.parity_prefactor]#

Type-Union for accessing the keys of the dicts in NodeSettings

class InteractionProperties(l_magnitude: int | None = None, l_projection: int | None = None, s_magnitude: Fraction | None = None, s_projection: Fraction | None = None, parity_prefactor: float | None = None)[source]#

Bases: object

Immutable data structure containing interaction properties.

Interactions are represented by a node on a MutableTransition. This class represents the properties that are carried collectively by the edges that this node connects.

Interaction properties are in particular important in the canonical basis of the helicity formalism. There, the coupled spin and angular momentum of each interaction are used for the Clebsch-Gordan coefficients for each term in a sequential amplitude.

Note

As opposed to NodeQuantumNumbers, the InteractionProperties class serves as an interface to the user.

l_magnitude: int | None[source]#
l_projection: int | None[source]#
s_magnitude: Fraction | None[source]#
s_projection: Fraction | None[source]#
parity_prefactor: float | None[source]#
arange(x_1: Fraction, x_2: Fraction, delta: Fraction = Fraction(1, 1)) → Generator[Fraction, None, None][source]#