diff --git a/.constraints/py3.10.txt b/.constraints/py3.10.txt index 4b57dd1b..aaacd609 100644 --- a/.constraints/py3.10.txt +++ b/.constraints/py3.10.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.10 # by the following command: # -# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.10.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=setuptools +# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.10.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=polarimetry-lc2pkpi --unsafe-package=setuptools # accessible-pygments==0.0.4 aiohttp==3.9.1 @@ -220,5 +220,5 @@ yarl==1.9.4 zipp==3.17.0 # The following packages are considered to be unsafe in a requirements file: -# polarimetry +# polarimetry-lc2pkpi # setuptools diff --git a/.constraints/py3.11.txt b/.constraints/py3.11.txt index f569ccf3..eddbbda8 100644 --- a/.constraints/py3.11.txt +++ b/.constraints/py3.11.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.11 # by the following command: # -# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.11.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=setuptools +# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.11.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=polarimetry-lc2pkpi --unsafe-package=setuptools # accessible-pygments==0.0.4 aiohttp==3.9.1 @@ -217,5 +217,5 @@ yarl==1.9.4 zipp==3.17.0 # The following packages are considered to be unsafe in a requirements file: -# polarimetry +# polarimetry-lc2pkpi # setuptools diff --git a/.constraints/py3.12.txt b/.constraints/py3.12.txt index 81247643..8a01e6d1 100644 --- a/.constraints/py3.12.txt +++ b/.constraints/py3.12.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.12 # by the following command: # -# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.12.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=setuptools +# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.12.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=polarimetry-lc2pkpi --unsafe-package=setuptools # accessible-pygments==0.0.4 aiohttp==3.9.1 @@ -217,5 +217,5 @@ yarl==1.9.4 zipp==3.17.0 # The following packages are considered to be unsafe in a requirements file: -# polarimetry +# polarimetry-lc2pkpi # setuptools diff --git a/.constraints/py3.8.txt b/.constraints/py3.8.txt index 55ffee61..d7934839 100644 --- a/.constraints/py3.8.txt +++ b/.constraints/py3.8.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.8 # by the following command: # -# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.8.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=setuptools +# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.8.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=polarimetry-lc2pkpi --unsafe-package=setuptools # accessible-pygments==0.0.4 aiohttp==3.9.1 @@ -224,5 +224,5 @@ yarl==1.9.4 zipp==3.17.0 # The following packages are considered to be unsafe in a requirements file: -# polarimetry +# polarimetry-lc2pkpi # setuptools diff --git a/.constraints/py3.9.txt b/.constraints/py3.9.txt index 05c03a51..1f8d0657 100644 --- a/.constraints/py3.9.txt +++ b/.constraints/py3.9.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.9 # by the following command: # -# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.9.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=setuptools +# pip-compile --extra=dev --no-annotate --output-file=.constraints/py3.9.txt --strip-extras --unsafe-package=pip --unsafe-package=polarimetry --unsafe-package=polarimetry-lc2pkpi --unsafe-package=setuptools # accessible-pygments==0.0.4 aiohttp==3.9.1 @@ -221,5 +221,5 @@ yarl==1.9.4 zipp==3.17.0 # The following packages are considered to be unsafe in a requirements file: -# polarimetry +# polarimetry-lc2pkpi # setuptools diff --git a/.cspell.json b/.cspell.json index a32cc5ec..9891add8 100644 --- a/.cspell.json +++ b/.cspell.json @@ -99,6 +99,7 @@ "ccrcr", "cmin", "commitlint", + "concat", "einsum", "exportnotebooks", "hangle", diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2d420f22..a3b6aea8 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -23,7 +23,6 @@ repos: - --no-github-actions - --no-gitpod - --no-prettierrc - - --no-pypi - --no-ruff - --no-version-branches - --repo-name=polarimetry diff --git a/README.md b/README.md index 053a3b19..1c877709 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # Aligned polarimetry field of the Λc → p π K decay -[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) -[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell) - [![10.1007/JHEP07(2023)228]()]() [![10.5281/zenodo.7544989](https://zenodo.org/badge/doi/10.5281/zenodo.7544989.svg)](https://doi.org/10.5281/zenodo.7544989) [![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html) +[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) +[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell) +[![PyPI package](https://badge.fury.io/py/polarimetry-lc2pki.svg)](https://pypi.org/project/polarimetry-lc2pki) +[![Supported Python versions](https://img.shields.io/pypi/pyversions/polarimetry-lc2pki)](https://pypi.org/project/polarimetry-lc2pki) + This repository a symbolic amplitude model for the decay $\Lambda^+_c \to p \pi^+ K^-$ that is aligned with [Dalitz-plot decomposition](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.101.034033) and computes an align polarimeter vector field $\vec\alpha$. Helicity couplings and other parameter values are taken from a recent study by the LHCb Collaboration[^1] and its [supplementary material](https://cds.cern.ch/record/2824328/files). diff --git a/docs/index.md b/docs/index.md index 852bea9e..5e98c534 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,9 +5,8 @@ myst: # Polarimetry in Λc⁺ → p K⁻ π⁺ -```{title} Welcome - -``` +:::{title} Welcome +::: [![10.48550/arXiv.2301.07010](https://zenodo.org/badge/doi/10.48550/arXiv.2301.07010.svg)](https://doi.org/10.48550/arXiv.2301.07010) [![10.5281/zenodo.7544989](https://zenodo.org/badge/doi/10.5281/zenodo.7544989.svg)](https://doi.org/10.5281/zenodo.7544989) @@ -81,17 +80,33 @@ This website shows all analysis results that led to the publication of [LHCb-PAP ::: -::::{only} latex - +::::{only} latex :::{note} - This document is a PDF rendering of the supplemental material hosted behind SSO-login on [lc2pkpi‑polarimetry.docs.cern.ch](https://lc2pkpi-polarimetry.docs.cern.ch). Go to this webpage for a more extensive and interactive experience. +::: +:::: + +[![PyPI package](https://badge.fury.io/py/polarimetry-lc2pki.svg)](https://pypi.org/project/polarimetry-lc2pki) +[![Supported Python versions](https://img.shields.io/pypi/pyversions/polarimetry-lc2pki)](https://pypi.org/project/polarimetry-lc2pki) + +Each of the pages contain code examples for how to reproduce the results with the Python package hosted at [github.com/ComPWA/polarimetry](https://github.com/ComPWA/polarimetry). However, to quickly get import the model in another package, it is possible to install the package from PyPI: +```bash +pip install lc2pkpi-polarimetry +``` + +:::{autolink-concat} ::: -:::: +Each of the models can then simply be imported as + +```python +import polarimetry + +model = polarimetry.published_model() +``` @@ -132,10 +147,7 @@ CERN GitLab (archived) {{ DOWNLOAD_PAPER_FIGURES }} -:::{dropdown} Notebook execution times - -```{nb-exec-table} - -``` - +::::{dropdown} Notebook execution times +:::{nb-exec-table} ::: +:::: diff --git a/pyproject.toml b/pyproject.toml index 87111848..1f0374e5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,15 +43,15 @@ dependencies = [ description = "Symbolic expressions that describe an aligned polarimeter vector field" dynamic = ["version"] license = {text = "GPLv3 or later"} -name = "polarimetry" +name = "polarimetry-lc2pkpi" requires-python = ">=3.8" [project.optional-dependencies] dev = [ - "polarimetry[doc]", - "polarimetry[jupyter]", - "polarimetry[sty]", - "polarimetry[test]", + "polarimetry-lc2pkpi[doc]", + "polarimetry-lc2pkpi[jupyter]", + "polarimetry-lc2pkpi[sty]", + "polarimetry-lc2pkpi[test]", "sphinx-autobuild", "tox >=1.9", ] @@ -85,7 +85,7 @@ jupyter = [ "jupyterlab-git", "jupyterlab-lsp", "jupyterlab-myst", - "polarimetry[doc]", + "polarimetry-lc2pkpi[doc]", "python-lsp-ruff", "python-lsp-server[rope]", ]