Skip to main content

Rule-based particle reaction problem solver on a quantum number level

Project description

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

Project details


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.7.tar.gz (294.1 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.7-py3-none-any.whl (80.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qrules-0.10.7.tar.gz
  • Upload date:
  • Size: 294.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for qrules-0.10.7.tar.gz
Algorithm Hash digest
SHA256 bb2ee2957aa3bd55d7eb38bb111823c26d9364d0d16c88730ddc97acf47c31c9
MD5 ab40f65354d49cd92521b69549446941
BLAKE2b-256 aa209d279bdd140a18959472cd1cc3e689b73e9554bc987a173e35e85ce713c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrules-0.10.7.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.7-py3-none-any.whl.

File metadata

  • Download URL: qrules-0.10.7-py3-none-any.whl
  • Upload date:
  • Size: 80.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for qrules-0.10.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a7936995dba23868d8d37319a9250aa4e0d90da9845a89da1ac476ce48abf694
MD5 143d4cc174185470ff9143718b8e836f
BLAKE2b-256 2c5dc1371af6f81376bebffd055911e355ff5972d2646135d961757ffe0a858f

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrules-0.10.7-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 Pingdom Monitoring Sentry Error logging StatusPage Status page