From 63de9112870ea4a32b735d904ba25969c7c6eba8 Mon Sep 17 00:00:00 2001 From: Remco de Boer Date: Mon, 2 Nov 2020 17:29:04 +0100 Subject: [PATCH] docs: list PWA packages (#33) * docs: add software bibliography support * docs: rename software page to Software --- cspell.json | 2 ++ docs/software.md | 56 ++++++++++++++++++++++++++++++++++ docs/software.rst | 36 ---------------------- docs/software/bibliography.bib | 16 ++++++++++ docs/software/z.references.rst | 28 +++++++++++++++++ docs/theory/z.references.rst | 4 +++ 6 files changed, 106 insertions(+), 36 deletions(-) create mode 100644 docs/software.md delete mode 100644 docs/software.rst create mode 100644 docs/software/bibliography.bib create mode 100644 docs/software/z.references.rst diff --git a/cspell.json b/cspell.json index 54827dda..fd1a8024 100644 --- a/cspell.json +++ b/cspell.json @@ -39,6 +39,7 @@ ], "language": "en-US", "words": [ + "besiii", "blazingly", "breit", "brookhaven", @@ -96,6 +97,7 @@ "notcited", "oneline", "pandoc", + "pawian", "propto", "pycompwa", "pydocstyle", diff --git a/docs/software.md b/docs/software.md new file mode 100644 index 00000000..e72cb082 --- /dev/null +++ b/docs/software.md @@ -0,0 +1,56 @@ + + +# Software + +```{warning} +These pages and are **under development**. +``` + +```{tip} +Have a look at [scikit-hep.org/developer](https://scikit-hep.org/developer)! +``` + +```{toctree} +--- +maxdepth: 2 +caption: Table of contents +--- +software/git +software/documentation +software/python +software/testing +software/tips +software/z.references +``` + +## PWA Software Packages + +Currently, sub-projects of the PWA Pages are: + +- {doc}`TensorWaves ` +- {doc}`TF-PWA ` +- {doc}`PWA Expert System ` +- {doc}`ComPWA ` +- {doc}`pycompwa ` + +Other PWA packages are: + +- [Pawian](https://panda-wiki.gsi.de/foswiki/bin/view/PWA/PawianPwaSoftware) + (Ruhr-Universität Bochum for [PANDA](https://panda.gsi.de) / + [BESIII](http://bes3.ihep.ac.cn)) +- [Laura++](https://laura.hepforge.org/) ([LHCb](https://lhcb.web.cern.ch)) + {cite}`backLauraDalitzPlot2018` +- [TensorFlowAnalysis](https://gitlab.cern.ch/poluekt/TensorFlowAnalysis) + ([LHCb](https://lhcb.web.cern.ch)) + - [AmpliTF](https://github.com/apoluekt/AmpliTF) + - [TFA2](https://github.com/apoluekt/TFA2) +- [ROOTPWA](https://github.com/ROOTPWA-Maintainers/ROOTPWA) + ([COMPASS](https://home.cern/science/experiments/compass)) +- [PyPWA](https://github.com/JeffersonLab/PyPWA) + ([Jefferson Lab](https://www.jlab.org)) +- [GPUPWA](https://sourceforge.net/projects/gpupwa) + ([BESIII](http://bes3.ihep.ac.cn)) + +Want to contribute or be part of this collection of PWA documentation +platforms? Welcome to contact the +[Common Partial Wave Analysis](https://github.com/ComPWA) organization! diff --git a/docs/software.rst b/docs/software.rst deleted file mode 100644 index bb905526..00000000 --- a/docs/software.rst +++ /dev/null @@ -1,36 +0,0 @@ -Software Development -==================== - -.. warning:: - These pages and are **under development**. - -.. tip:: - Have a look at `scikit-hep.org/developer - `_! - - -.. toctree:: - :maxdepth: 2 - :caption: Table of contents - - software/git - software/documentation - software/python - software/testing - software/tips - - -PWA Software Packages ---------------------- - -Currently, sub-projects of the PWA Pages are: - -* :doc:`TensorWaves ` -* :doc:`TF-PWA ` -* :doc:`PWA Expert System ` -* :doc:`ComPWA ` -* :doc:`pycompwa ` - -Want to contribute or be part of this collection of PWA documentation -platforms? Welcome to contact the `Common Partial Wave Analysis -`_ organization! diff --git a/docs/software/bibliography.bib b/docs/software/bibliography.bib new file mode 100644 index 00000000..01332855 --- /dev/null +++ b/docs/software/bibliography.bib @@ -0,0 +1,16 @@ + +@article{backLauraDalitzPlot2018, + title = {Laura++: {{A Dalitz}} Plot Fitter}, + shorttitle = {Laura++}, + author = {Back, John and Gershon, Tim and Harrison, Paul and Latham, Thomas and O’Hanlon, Daniel and Qian, Wenbin and {del Amo Sanchez}, Pablo and Craik, Daniel and Ilic, Jelena and Otalora Goicochea, Juan Martin and Puccio, Eugenia and Silva Coutinho, Rafael and Whitehead, Mark}, + year = {2018}, + month = oct, + volume = {231}, + pages = {198--242}, + issn = {00104655}, + doi = {10.1016/j.cpc.2018.04.017}, + journal = {Computer Physics Communications}, + language = {en} +} + + diff --git a/docs/software/z.references.rst b/docs/software/z.references.rst new file mode 100644 index 00000000..f1273aa4 --- /dev/null +++ b/docs/software/z.references.rst @@ -0,0 +1,28 @@ +.. cspell:ignore labelprefix + +Bibliography +------------ + +.. tip:: Download this bibliography as BibTeX :download:`here + `. + +.. rubric:: References + +.. bibliography:: bibliography.bib + :style: unsrt_et_al + :labelprefix: S + :cited: + +.. rubric:: Further reading + +.. bibliography:: bibliography.bib + :style: unsrt_et_al + :labelprefix: S + :list: bullet + :notcited: + +.. toggle:: + + See `here + `__ + for why this page is called :doc:`z.references `. diff --git a/docs/theory/z.references.rst b/docs/theory/z.references.rst index f1db6fc8..ffd904e5 100644 --- a/docs/theory/z.references.rst +++ b/docs/theory/z.references.rst @@ -1,3 +1,5 @@ +.. cspell:ignore labelprefix + Bibliography ------------ @@ -8,12 +10,14 @@ Bibliography .. bibliography:: bibliography.bib :style: unsrt_et_al + :labelprefix: T :cited: .. rubric:: Further reading .. bibliography:: bibliography.bib :style: unsrt_et_al + :labelprefix: T :list: bullet :notcited: