Skip to content

Commit

Permalink
docs: list PWA packages (#33)
Browse files Browse the repository at this point in the history
* docs: add software bibliography support
* docs: rename software page to Software
  • Loading branch information
redeboer authored Nov 2, 2020
1 parent 1386d03 commit 63de911
Show file tree
Hide file tree
Showing 6 changed files with 106 additions and 36 deletions.
2 changes: 2 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
],
"language": "en-US",
"words": [
"besiii",
"blazingly",
"breit",
"brookhaven",
Expand Down Expand Up @@ -96,6 +97,7 @@
"notcited",
"oneline",
"pandoc",
"pawian",
"propto",
"pycompwa",
"pydocstyle",
Expand Down
56 changes: 56 additions & 0 deletions docs/software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!-- cspell:ignore ampli gpupwa rootpwa Universität -->

# 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 <tensorwaves:index>`
- {doc}`TF-PWA <tf_pwa:index>`
- {doc}`PWA Expert System <expertsystem:index>`
- {doc}`ComPWA <ComPWA:index>`
- {doc}`pycompwa <pycompwa:index>`

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!
36 changes: 0 additions & 36 deletions docs/software.rst

This file was deleted.

16 changes: 16 additions & 0 deletions docs/software/bibliography.bib
Original file line number Diff line number Diff line change
@@ -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}
}


28 changes: 28 additions & 0 deletions docs/software/z.references.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. cspell:ignore labelprefix
Bibliography
------------

.. tip:: Download this bibliography as BibTeX :download:`here
</software/bibliography.bib>`.

.. 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
<https://sphinxcontrib-bibtex.readthedocs.io/en/latest/usage.html#unresolved-citations-across-documents>`__
for why this page is called :doc:`z.references </software/z.references>`.
4 changes: 4 additions & 0 deletions docs/theory/z.references.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. cspell:ignore labelprefix
Bibliography
------------

Expand All @@ -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:

Expand Down

0 comments on commit 63de911

Please sign in to comment.