From 893d417328ae8feb34505b20619a0300eb50837b Mon Sep 17 00:00:00 2001 From: Remco de Boer Date: Mon, 27 Sep 2021 15:48:27 +0200 Subject: [PATCH] docs: improve main project overview (#66) * docs: add Zenodo, PyPI, and RTD badges on about page * style: switch to project listing through sphinx-panels --- .cspell.json | 3 ++- docs/about.md | 63 +++++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 55 insertions(+), 11 deletions(-) diff --git a/.cspell.json b/.cspell.json index 657c5189..55a66db7 100644 --- a/.cspell.json +++ b/.cspell.json @@ -87,7 +87,8 @@ "unphysical", "vectorize", "weisskopf", - "wigners" + "wigners", + "Zenodo" ], "ignoreWords": [ "adrs", diff --git a/docs/about.md b/docs/about.md index f3204535..e2ee7770 100644 --- a/docs/about.md +++ b/docs/about.md @@ -17,16 +17,59 @@ details, see the {doc}`develop page `. The main projects that ComPWA is currently developing are: -- {doc}`QRules `, a package that helps generating allowed - transitions between quantum states on the basis of quantum number - conservation rules. -- {doc}`AmpForm `, which helps to formulate amplitude models for - different spin formalisms and with different dynamics. -- {doc}`TensorWaves `, a fitter and data generation package for - multiple computational back-ends. -- {doc}`PWA Pages `, an overview of the basis of Partial Wave - Analysis that provides links to the most important literature and software in - the field. +:::{panels} + +```{link-button} https://github.com/ComPWA/qrules +:text: QRules +:classes: btn-block btn-outline-primary font-weight-bold +``` + +^^^^^^^ + +[![Documentation build status](https://readthedocs.org/projects/qrules/badge/?version=latest)](https://qrules.readthedocs.io) +[![PyPI package](https://badge.fury.io/py/qrules.svg)](https://pypi.org/project/qrules) +[![Zenodo DOI](https://zenodo.org/badge/doi/10.5281/zenodo.5526360.svg)](https://doi.org/10.5281/zenodo.5526360)
+Rule-based particle reaction problem solver on a quantum number level + +--- + +```{link-button} https://github.com/ComPWA/ampform +:text: AmpForm +:classes: btn-block btn-outline-primary font-weight-bold +``` + +^^^^^^^ +[![Documentation build status](https://readthedocs.org/projects/qrules/badge/?version=latest)](https://qrules.readthedocs.io) +[![PyPI package](https://badge.fury.io/py/ampform.svg)](https://pypi.org/project/ampform) +[![Zenodo DOI](https://zenodo.org/badge/doi/10.5281/zenodo.5526648.svg)](https://doi.org/10.5281/zenodo.5526648)
+Automatically generate symbolic amplitude models for Partial Wave Analysis + +--- + +```{link-button} https://github.com/ComPWA/tensorwaves +:text: TensorWaves +:classes: btn-block btn-outline-primary font-weight-bold +``` + +^^^^^^^ +[![Documentation build status](https://readthedocs.org/projects/qrules/badge/?version=latest)](https://qrules.readthedocs.io) +[![PyPI package](https://badge.fury.io/py/tensorwaves.svg)](https://pypi.org/project/tensorwaves) +[![Zenodo DOI](https://zenodo.org/badge/doi/10.5281/zenodo.5526650.svg)](https://doi.org/10.5281/zenodo.5526650)
+Python fitter package for multiple computational back-ends + +--- + +```{link-button} https://github.com/ComPWA/PWA-pages +:text: PWA Pages +:classes: btn-block btn-outline-primary font-weight-bold +``` + +^^^^^^^ + +[![Documentation build status](https://readthedocs.org/projects/pwa/badge/?version=latest)](https://pwa.readthedocs.io)
+A central knowledge-base for Partial Wave Analysis theory and software + +::: Finally, the {doc}`technical reports ` on these pages ([compwa-org.rtfd.io](https://compwa-org.readthedocs.io)) describe more general