Skip to main content

Quantum Number Conservation Rules

10.5281/zenodo.5526360 License

PyPI package Conda package Supported Python versions

Binder Google Colab Open in Visual Studio Code

Documentation pre-commit.ci status CI Type-checked with mypy Test coverage Spelling checked code style: prettier Ruff uv

QRules is a Python package for validating and generating particle reactions using quantum number conservation rules. The user only has to provide a certain set of boundary conditions (initial and final state, allowed interaction types, expected decay topologies, etc.). QRules will then span the space of allowed quantum numbers over all allowed decay topologies and particle instances that correspond with the sets of allowed quantum numbers it has found.

The resulting state transition objects are particularly useful for amplitude analysis / Partial Wave Analysis as they contain all information (such as expected masses, widths, and spin projections) that is needed to formulate an amplitude model.

Visit qrules.rtfd.io for more information!

For an overview of upcoming releases and planned functionality, see here.

Available features

  • Input: Particle database
    • Source of truth: PDG
    • Predefined particle list file
    • Option to overwrite and append with custom particle definitions
  • State transition graph
    • Feynman graph like description of the reactions
    • Visualization of the decay topology
  • Conservation rules
    • Open-closed design
    • Large set of predefined rules
      • Spin/Angular momentum conservation
      • Quark and Lepton flavor conservation (incl. isospin)
      • Baryon number conservation
      • EM-charge conservation
      • Parity, C-Parity, G-Parity conservation
      • Mass conservation
    • Predefined sets of conservation rules representing Strong, EM, Weak interactions

Contribute

See CONTRIBUTING.md

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qrules-0.10.10.tar.gz (314.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qrules-0.10.10-py3-none-any.whl (77.4 kB view details)

Uploaded Python 3

File details

Details for the file qrules-0.10.10.tar.gz.

File metadata

  • Download URL: qrules-0.10.10.tar.gz
  • Upload date:
  • Size: 314.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for qrules-0.10.10.tar.gz
Algorithm Hash digest
SHA256 c1b99e17c5a84eafa40e8dabc93417bf5a348648279b2de42c87b72b3a169732
MD5 201afb2f7d5fe455dc4379b80a430265
BLAKE2b-256 f9c511a740331f8ae6ced4d59ef49a111b486e40725f9fc3b609cf205a10242e

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrules-0.10.10.tar.gz:

Publisher: cd.yml on ComPWA/qrules

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qrules-0.10.10-py3-none-any.whl.

File metadata

  • Download URL: qrules-0.10.10-py3-none-any.whl
  • Upload date:
  • Size: 77.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for qrules-0.10.10-py3-none-any.whl
Algorithm Hash digest
SHA256 2b9748e2c6756091cff59d42b135b88b5e31e7bf17a35d83207d6f68b3fba715
MD5 61b729efede090b796571ecee1b0cea2
BLAKE2b-256 abe3de3c69c04bb0459199264e5f4fdc38755560d196630e13835c5fd57e2fcb

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrules-0.10.10-py3-none-any.whl:

Publisher: cd.yml on ComPWA/qrules

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page