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 GitPod

Documentation pre-commit.ci status pytest Checked with mypy Test coverage Codacy Badge Spelling checked code style: prettier Ruff

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.3.tar.gz (145.6 kB view details)

Uploaded Source

Built Distribution

qrules-0.10.3-py3-none-any.whl (79.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qrules-0.10.3.tar.gz
  • Upload date:
  • Size: 145.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for qrules-0.10.3.tar.gz
Algorithm Hash digest
SHA256 729fca4ef0713c9207d54aeab887be593bb7e1a2605ed378177739d8289bab6f
MD5 b20394e27c06cfb93d4837bd2358767a
BLAKE2b-256 bb89849dc7c14849015fca7380d7b72590383dc8036308d464cff9a247a38f5a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qrules-0.10.3-py3-none-any.whl
  • Upload date:
  • Size: 79.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for qrules-0.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 19fb1818794830184881476bd5f3f4f64aa738ced14afde4ab7ae69598b74071
MD5 59ba3001195587a6f4e4a884a1e58580
BLAKE2b-256 498f9a3cfe2cf810408afba00365c819ed62f635ef126b7c16cc74243b0d44b4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page