https://github.com/compwa/sphinx-hep-pdgref
Sphinx role for linking to PDG reviews and listing
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.4%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Sphinx role for linking to PDG reviews and listing
Basic Info
Statistics
- Stars: 3
- Watchers: 7
- Forks: 0
- Open Issues: 1
- Releases: 6
Topics
Metadata Files
README.md
PDG role for Sphinx
This package is a Sphinx extension that makes it easy to refer to PDF files of reviews and particle listings in the PDG.
Installation
Just install through PyPI with pip:
bash
pip install sphinx-hep-pdgref
Next, in your
Sphinx configuration file
(conf.py), add "sphinx_hep_pdgref" to your extensions:
python
extensions = [
# ...
"sphinx_hep_pdgref",
# ...
]
Usage
There are two roles, one for the particle listings and one for the review. These roles can be used as follows:
``restructuredtext
:pdg-listing:K-zero`
:pdg-review:Kinematics
:pdg-review:2014; Resonances
:pdg-review:Resonances; 2018; pp. 2-4, 7
:pdg-review:QCD; p5
:pdg-review:PDG2015; Quark Model; p.2
```
which will render in the HTML pages as:
Note that the resulting links lead to the correct page as well!
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
GitHub Events
Total
- Release event: 1
- Delete event: 4
- Push event: 30
- Pull request review event: 2
- Pull request event: 6
- Create event: 5
Last Year
- Release event: 1
- Delete event: 4
- Push event: 30
- Pull request review event: 2
- Pull request event: 6
- Create event: 5
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Remco de Boer | r****r@g****m | 50 |
| pre-commit-ci[bot] | 6****] | 12 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 17
- Average time to close issues: N/A
- Average time to close pull requests: 6 days
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.06
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 8
Past Year
- Issues: 0
- Pull requests: 9
- Average time to close issues: N/A
- Average time to close pull requests: 4 days
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 4
Top Authors
Issue Authors
Pull Request Authors
- redeboer (12)
- pre-commit-ci[bot] (10)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 361 last-month
- Total dependent packages: 2
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
pypi.org: sphinx-hep-pdgref
Sphinx role for linking to PDG reviews and listing
- Documentation: https://github.com/ComPWA/sphinx-hep-pdgref/blob/main/README.md
- License: BSD 3-Clause License
-
Latest release: 0.2.1
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- JulienKode/pull-request-name-linter-action v0.1.2 composite
- actions/checkout v3 composite
- docker://agilepathway/pull-request-label-checker latest composite
- release-drafter/release-drafter v5 composite
- ComPWA/actions/clean-caches v1 composite