Science Score: 77.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 12 DOI reference(s) in README -
✓Academic publication links
Links to: aps.org, zenodo.org -
✓Committers with academic emails
1 of 5 committers (20.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.8%) to scientific vocabulary
Keywords from Contributors
Repository
Polarimetry for the decay Λc → p K π
Basic Info
- Host: GitHub
- Owner: ComPWA
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://compwa.github.io/polarimetry
- Size: 2.01 MB
Statistics
- Stars: 5
- Watchers: 5
- Forks: 1
- Open Issues: 8
- Releases: 11
Metadata Files
README.md
Aligned polarimetry field of the Λc → p π K decay
This repository contains the source code for “$\Lambdac^+$ polarimetry using the dominant hadronic mode” (2023) by the LHCb Collaboration (10.1007/JHEP07(2023)228). It uses ampform-dpd to formulate symbolic amplitude models for the decay $\Lambda^+c \to p \pi^+ K^-$ that are aligned with Dalitz-plot decomposition. The aligned amplitudes are used to compute polarimeter vector field $\vec\alpha$ over the Dalitz plane. Helicity couplings and other parameter values are taken from a recent study by the LHCb Collaboration[^1] and its supplementary material.
[^1]: Amplitude analysis of the $\Lambda^+c \to p K^- \pi^+$ decay and $\Lambda^+c$ baryon polarization measurement in semileptonic beauty hadron decays (2022) [link]
Installation
All the dependencies required to work on this Repository are managed by Pixi. If you have installed Pixi, you can simply start developing by activating the environment with:
shell
pixi shell
This will install uv for managing Python and its dependencies as well as Julia. Then it activates the environment and you can start developing.
Common checks are defined under pixi.toml and can be listed with
shell
pixi task list
For example, you build the documentation with executed notebooks with
shell
pixi run docnb
Style checks are enforced with Pre-commit. You should install this system-wide once, for instance through uv:
shell
uv tool install --with pre-commit-uv pre-commit
You can then install the Git hooks for this repository, so that the checks are run automatically before each commit:
shell
pre-commit install
[!TIP] For more information about the local Python developer environment, see here.
This repository also contains Julia source code and Pluto notebooks. Julia can be downloaded here. You then have to activate and instantiated the Julia environment provided in the julia folder. This can be done as follows from the root directory:
shell
julia --project=./julia -e 'import Pkg; Pkg.instantiate()'
Documentation dependencies
To build the documentation, you need to install LaTeX and some additional fonts. In Ubuntu, this can be done with:
shell
sudo apt-get install -y cm-super dvipng texlive-latex-extra
In addition, for building the documentation as a single PDF file, you need to install XeTeX:
shell
sudo apt-get install -y inkscape latexmk make texlive-fonts-extra texlive-xetex xindy
Building the documentation
Having installed the Python environment, you can build the documentation with:[^2]
shell
pixi run docnb
This will run all Jupyter notebooks and convert the output to static webpages (view the output under docs/_build/html/index.html). Running all notebooks from scratch (without any available cache) should take around one hour.
If you have installed Julia and instantiated the Julia environment, you can embed the Pluto notebooks as static pages in the documentation with:
shell
pixi run docnb-pluto
or, alternatively, by executing all Jupyter and Pluto notebooks (ignoring any existing caches):
shell
pixi run docnb-pluto-force
The above commands result in a static HTML webpage. It's also possible to render the notebook as a single PDF file. This can be done as follows:
shell
pixi run pdf
Just as above, cell output can be rendered by appending nb:
shell
pixi run pdfnb
[^2]: It's also possible have a look at the documentation without cell output (just as a check for the links). This can be done with:
```shell
pixi run doc
```
Owner
- Name: Common Partial Wave Analysis
- Login: ComPWA
- Kind: organization
- Email: compwa@ep1.rub.de
- Location: Germany
- Website: https://compwa.github.io
- Repositories: 36
- Profile: https://github.com/ComPWA
Making amplitude analysis reproducible, understandable, and easy to do
Citation (CITATION.cff)
cff-version: 1.2.0
message: If you use this software, please cite it as below.
title: >-
\(\Lambda^+_\mathrm{c}\) polarimetry using the dominant hadronic mode
abstract: |-
The polarimeter vector field for multibody decays of a spin-half baryon is introduced as a generalisation of the baryon asymmetry parameters. Using a recent amplitude analysis of the (Lambda^+_mathrm{c} o p K^- pi^+) decay performed at the LHCb experiment, we compute the distribution of the kinematic-dependent polarimeter vector for this process in the space of Mandelstam variables to express the polarised decay rate in a model-agnostic form. The obtained representation can facilitate polarisation measurements of the \\(\Lambda^+_\mathrm{c}\\) baryon and eases inclusion of the \\(\Lambda^+_\mathrm{c} \to p K^- \pi^+\\) decay mode in hadronic amplitude analyses.
authors:
- family-names: de Boer
given-names: Remco E.
affiliation: Ruhr University Bochum
orcid: https://orcid.org/0000-0001-5846-2206
- family-names: Mikhasenko
given-names: Mikhail
affiliation: Excellence Cluster ORIGINS, Munich, Germany
orcid: https://orcid.org/0000-0002-6969-2063
- family-names: Fritsch
given-names: Miriam
affiliation: Ruhr University Bochum
orcid: https://orcid.org/0000-0002-6463-8295
doi: 10.5281/zenodo.7544989
keywords:
- amplitude analysis
- computer algebra system
- LHCb
- partial wave analysis
- particle physics
- polarimetry
- polarization
license: Apache-2.0
repository-code: https://github.com/ComPWA/polarimetry
type: software
url: https://lc2pkpi-polarimetry.docs.cern.ch
GitHub Events
Total
- Issues event: 11
- Delete event: 39
- Issue comment event: 4
- Push event: 263
- Pull request review event: 12
- Pull request event: 68
- Create event: 36
Last Year
- Issues event: 11
- Delete event: 39
- Issue comment event: 4
- Push event: 263
- Pull request review event: 12
- Pull request event: 68
- Create event: 36
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Remco de Boer | 2****r | 255 |
| Misha Mikhasenko | m****o@c****h | 38 |
| pre-commit-ci[bot] | 6****] | 5 |
| dependabot[bot] | 4****] | 4 |
| grayson-helmholz | 1****z | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 56
- Total pull requests: 204
- Average time to close issues: about 1 month
- Average time to close pull requests: 8 days
- Total issue authors: 2
- Total pull request authors: 4
- Average comments per issue: 2.14
- Average comments per pull request: 1.06
- Merged pull requests: 162
- Bot issues: 0
- Bot pull requests: 46
Past Year
- Issues: 6
- Pull requests: 55
- Average time to close issues: 14 days
- Average time to close pull requests: 7 days
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 0.17
- Average comments per pull request: 0.02
- Merged pull requests: 27
- Bot issues: 0
- Bot pull requests: 34
Top Authors
Issue Authors
- redeboer (40)
- mmikhasenko (17)
Pull Request Authors
- redeboer (143)
- dependabot[bot] (35)
- mmikhasenko (18)
- pre-commit-ci[bot] (12)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- ComPWA/actions/pip-install v1 composite
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/deploy-pages v1 composite
- actions/upload-artifact v3 composite
- actions/upload-pages-artifact v1 composite
- JulienKode/pull-request-name-linter-action v0.5.0 composite
- actions/checkout v3 composite
- docker://agilepathway/pull-request-label-checker latest composite
- release-drafter/release-drafter v5 composite
- IPython *
- PyYAML *
- ampform >=0.14.1
- attrs >=20.1.0
- cloudpickle *
- matplotlib *
- numpy *
- sympy >=1.10
- tensorwaves [jax] >=0.4.5
- typing-extensions python_version <"3.8.0"
- ComPWA/actions/clean-caches v1 composite
- actions/cache v3 composite
- actions/checkout v4 composite
- julia-actions/setup-julia v1 composite