qrules


Nameqrules JSON
Version 0.9.8 PyPI version JSON
download
home_page
SummaryRule-based particle reaction problem solver on a quantum number level
upload_time2023-04-13 16:38:18
maintainer
docs_urlNone
authorCommon Partial Wave Analysis
requires_python>=3.6
licenseGPLv3 or later
keywords hep pwa amplitude analysis partial wave analysis particle physics particles physics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Quantum Number Conservation Rules

[![10.5281/zenodo.5526360](https://zenodo.org/badge/doi/10.5281/zenodo.5526360.svg)](https://doi.org/10.5281/zenodo.5526360)
[![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html)

[![PyPI package](https://badge.fury.io/py/qrules.svg)](https://pypi.org/project/qrules)
[![Conda package](https://anaconda.org/conda-forge/qrules/badges/version.svg)](https://anaconda.org/conda-forge/qrules)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/qrules)](https://pypi.org/project/qrules)

[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ComPWA/qrules/stable?filepath=docs/usage)
[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/qrules/blob/stable)
[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/qrules)
[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/qrules)

[![Documentation](https://readthedocs.org/projects/qrules/badge/?version=latest)](https://qrules.readthedocs.io)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/qrules/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/qrules/main)
[![pytest](https://github.com/ComPWA/qrules/workflows/pytest/badge.svg)](https://github.com/ComPWA/qrules/actions?query=branch%3Amain+workflow%3Apytest)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy.readthedocs.io)
[![Test coverage](https://codecov.io/gh/ComPWA/qrules/branch/main/graph/badge.svg)](https://codecov.io/gh/ComPWA/qrules)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/deeee5b9e2bb4b3daa655942c71e17da)](https://www.codacy.com/gh/ComPWA/qrules)
[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)

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](https://qrules.readthedocs.io) for more information!

For an overview of **upcoming releases and planned functionality**, see
[here](https://github.com/ComPWA/qrules/milestones?direction=asc&sort=title&state=open).

## 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`](./CONTRIBUTING.md)



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "qrules",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "compwa-admin@ep1.rub.de",
    "keywords": "HEP,PWA,amplitude analysis,partial wave analysis,particle physics,particles,physics",
    "author": "Common Partial Wave Analysis",
    "author_email": "compwa-admin@ep1.rub.de",
    "download_url": "https://files.pythonhosted.org/packages/d3/cc/98cc8d130f60b192577a5de0471646b4bd49a777780a8a9a8197160eb9d3/qrules-0.9.8.tar.gz",
    "platform": null,
    "description": "# Quantum Number Conservation Rules\n\n[![10.5281/zenodo.5526360](https://zenodo.org/badge/doi/10.5281/zenodo.5526360.svg)](https://doi.org/10.5281/zenodo.5526360)\n[![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html)\n\n[![PyPI package](https://badge.fury.io/py/qrules.svg)](https://pypi.org/project/qrules)\n[![Conda package](https://anaconda.org/conda-forge/qrules/badges/version.svg)](https://anaconda.org/conda-forge/qrules)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/qrules)](https://pypi.org/project/qrules)\n\n[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ComPWA/qrules/stable?filepath=docs/usage)\n[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/qrules/blob/stable)\n[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/qrules)\n[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/qrules)\n\n[![Documentation](https://readthedocs.org/projects/qrules/badge/?version=latest)](https://qrules.readthedocs.io)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/qrules/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/qrules/main)\n[![pytest](https://github.com/ComPWA/qrules/workflows/pytest/badge.svg)](https://github.com/ComPWA/qrules/actions?query=branch%3Amain+workflow%3Apytest)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy.readthedocs.io)\n[![Test coverage](https://codecov.io/gh/ComPWA/qrules/branch/main/graph/badge.svg)](https://codecov.io/gh/ComPWA/qrules)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/deeee5b9e2bb4b3daa655942c71e17da)](https://www.codacy.com/gh/ComPWA/qrules)\n[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)\n\nQRules is a Python package for **validating and generating particle reactions** using\nquantum number conservation rules. The user only has to provide a certain set of\nboundary conditions (initial and final state, allowed interaction types, expected decay\ntopologies, etc.). QRules will then span the space of allowed quantum numbers over all\nallowed decay topologies and particle instances that correspond with the sets of allowed\nquantum numbers it has found.\n\nThe resulting state transition objects are particularly useful for **amplitude analysis\n/ Partial Wave Analysis** as they contain all information (such as expected masses,\nwidths, and spin projections) that is needed to formulate an amplitude model.\n\nVisit [qrules.rtfd.io](https://qrules.readthedocs.io) for more information!\n\nFor an overview of **upcoming releases and planned functionality**, see\n[here](https://github.com/ComPWA/qrules/milestones?direction=asc&sort=title&state=open).\n\n## Available features\n\n- **Input**: Particle database\n  - Source of truth: PDG\n  - Predefined particle list file\n  - Option to overwrite and append with custom particle definitions\n- **State transition graph**\n  - Feynman graph like description of the reactions\n  - Visualization of the decay topology\n- **Conservation rules**\n  - Open-closed design\n  - Large set of predefined rules\n    - Spin/Angular momentum conservation\n    - Quark and Lepton flavor conservation (incl. isospin)\n    - Baryon number conservation\n    - EM-charge conservation\n    - Parity, C-Parity, G-Parity conservation\n    - Mass conservation\n  - Predefined sets of conservation rules representing Strong, EM, Weak interactions\n\n## Contribute\n\nSee [`CONTRIBUTING.md`](./CONTRIBUTING.md)\n\n\n",
    "bugtrack_url": null,
    "license": "GPLv3 or later",
    "summary": "Rule-based particle reaction problem solver on a quantum number level",
    "version": "0.9.8",
    "split_keywords": [
        "hep",
        "pwa",
        "amplitude analysis",
        "partial wave analysis",
        "particle physics",
        "particles",
        "physics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4ae125aedbf17917c7fd95d18445d68d0d393be2d7cd88fa5c400d5fad6f8e45",
                "md5": "a2645e419274c1e41205e3710bd82ec6",
                "sha256": "f69f51f251d9bea42e37039be5b6e47e09815ff6ea5e07c6097a020daf0f8c8d"
            },
            "downloads": -1,
            "filename": "qrules-0.9.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a2645e419274c1e41205e3710bd82ec6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 84642,
            "upload_time": "2023-04-13T16:38:15",
            "upload_time_iso_8601": "2023-04-13T16:38:15.950468Z",
            "url": "https://files.pythonhosted.org/packages/4a/e1/25aedbf17917c7fd95d18445d68d0d393be2d7cd88fa5c400d5fad6f8e45/qrules-0.9.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3cc98cc8d130f60b192577a5de0471646b4bd49a777780a8a9a8197160eb9d3",
                "md5": "64fd39ff7a9b060f9535ffb633f14d49",
                "sha256": "2ecf44e3e1f6364e26ecdd8c89498c032c05f6b0fc98881a26ba3c6bcbc827a0"
            },
            "downloads": -1,
            "filename": "qrules-0.9.8.tar.gz",
            "has_sig": false,
            "md5_digest": "64fd39ff7a9b060f9535ffb633f14d49",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 152901,
            "upload_time": "2023-04-13T16:38:18",
            "upload_time_iso_8601": "2023-04-13T16:38:18.198596Z",
            "url": "https://files.pythonhosted.org/packages/d3/cc/98cc8d130f60b192577a5de0471646b4bd49a777780a8a9a8197160eb9d3/qrules-0.9.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-13 16:38:18",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "qrules"
}
        
Elapsed time: 0.05361s