docs!: describe helicity vs canonical (#95)

* build: add rich to doc requirements * ci: upgrade pinned requirements (automatic) * docs: add spin formalism papers to bibliography Co-authored-by: GitHub Action <41898282+github-actions[bot]@users.noreply.github.com>
ComPWA · Jul 14, 2021 · 5e04a05 · 5e04a05
1 parent 5c2d252
commit 5e04a05
Show file tree

Hide file tree

Showing 9 changed files with 434 additions and 28 deletions.
diff --git a/.constraints/py3.6.txt b/.constraints/py3.6.txt
@@ -14,15 +14,17 @@ async-generator==1.10
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
+backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
 black==21.6b0
 bleach==3.3.0
 certifi==2021.5.30
 cffi==1.14.6
 cfgv==3.3.0
-chardet==4.0.0
+charset-normalizer==2.0.1
 click==8.0.1
 colorama==0.4.4
+commonmark==0.9.1
 contextvars==2.4
 coverage==5.5
 cycler==0.10.0
@@ -48,10 +50,10 @@ future==0.18.2
 gitdb==4.0.7
 gitpython==3.1.18
 gprof2dot==2021.2.21
-graphviz==0.16
+graphviz==0.17
 hepunits==2.1.1
 identify==2.2.11
-idna==2.10
+idna==3.2
 imagesize==1.2.0
 immutables==0.15
 importlib-metadata==4.6.1
@@ -114,6 +116,7 @@ pexpect==4.8.0
 pickleshare==0.7.5
 pillow==8.3.1
 pip-tools==6.2.0
+platformdirs==2.0.2
 pluggy==0.13.1
 pre-commit==2.13.0
 prometheus-client==0.11.0
@@ -138,16 +141,17 @@ pytest-notebook==0.6.1
 pytest-profiling==1.7.0
 pytest-xdist==2.3.0
 python-constraint==1.4.0
-python-dateutil==2.8.1
+python-dateutil==2.8.2
 pytz==2021.1
 pyyaml==5.4.1
 pyzmq==22.1.0
-qrules==0.9.0
+qrules==0.9.1
 radon==5.0.1
 regex==2021.7.6
-requests==2.25.1
+requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
+rich==10.6.0
 send2trash==1.7.1
 six==1.16.0
 smmap==4.0.0
@@ -182,7 +186,7 @@ typed-ast==1.4.3
 types-docutils==0.1.7
 typing-extensions==3.10.0.0 ; python_version < "3.8.0"
 urllib3==1.26.6
-virtualenv==20.4.7
+virtualenv==20.5.0
 wcwidth==0.2.5
 webencodings==0.5.1
 websocket-client==1.1.0

diff --git a/.constraints/py3.7.txt b/.constraints/py3.7.txt
@@ -14,15 +14,17 @@ async-generator==1.10
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
+backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
 black==21.6b0
 bleach==3.3.0
 certifi==2021.5.30
 cffi==1.14.6
 cfgv==3.3.0
-chardet==4.0.0
+charset-normalizer==2.0.1
 click==8.0.1
 colorama==0.4.4
+commonmark==0.9.1
 coverage==5.5
 cycler==0.10.0
 debugpy==1.3.0
@@ -47,10 +49,10 @@ future==0.18.2
 gitdb==4.0.7
 gitpython==3.1.18
 gprof2dot==2021.2.21
-graphviz==0.16
+graphviz==0.17
 hepunits==2.1.1
 identify==2.2.11
-idna==2.10
+idna==3.2
 imagesize==1.2.0
 importlib-metadata==3.10.1
 importlib-resources==5.2.0
@@ -113,6 +115,7 @@ pexpect==4.8.0
 pickleshare==0.7.5
 pillow==8.3.1
 pip-tools==6.2.0
+platformdirs==2.0.2
 pluggy==0.13.1
 pre-commit==2.13.0
 prometheus-client==0.11.0
@@ -137,16 +140,17 @@ pytest-notebook==0.6.1
 pytest-profiling==1.7.0
 pytest-xdist==2.3.0
 python-constraint==1.4.0
-python-dateutil==2.8.1
+python-dateutil==2.8.2
 pytz==2021.1
 pyyaml==5.4.1
 pyzmq==22.1.0
-qrules==0.9.0
+qrules==0.9.1
 radon==5.0.1
 regex==2021.7.6
-requests==2.25.1
+requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
+rich==10.6.0
 send2trash==1.7.1
 six==1.16.0
 smmap==4.0.0
@@ -181,7 +185,7 @@ typed-ast==1.4.3
 types-docutils==0.1.7
 typing-extensions==3.10.0.0 ; python_version < "3.8.0"
 urllib3==1.26.6
-virtualenv==20.4.7
+virtualenv==20.5.0
 wcwidth==0.2.5
 webencodings==0.5.1
 websocket-client==1.1.0

diff --git a/.constraints/py3.8.txt b/.constraints/py3.8.txt
@@ -14,15 +14,17 @@ async-generator==1.10
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
+backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
 black==21.6b0
 bleach==3.3.0
 certifi==2021.5.30
 cffi==1.14.6
 cfgv==3.3.0
-chardet==4.0.0
+charset-normalizer==2.0.1
 click==8.0.1
 colorama==0.4.4
+commonmark==0.9.1
 coverage==5.5
 cycler==0.10.0
 debugpy==1.3.0
@@ -47,10 +49,10 @@ future==0.18.2
 gitdb==4.0.7
 gitpython==3.1.18
 gprof2dot==2021.2.21
-graphviz==0.16
+graphviz==0.17
 hepunits==2.1.1
 identify==2.2.11
-idna==2.10
+idna==3.2
 imagesize==1.2.0
 importlib-metadata==4.6.1
 importlib-resources==5.2.0
@@ -113,6 +115,7 @@ pexpect==4.8.0
 pickleshare==0.7.5
 pillow==8.3.1
 pip-tools==6.2.0
+platformdirs==2.0.2
 pluggy==0.13.1
 pre-commit==2.13.0
 prometheus-client==0.11.0
@@ -137,16 +140,17 @@ pytest-notebook==0.6.1
 pytest-profiling==1.7.0
 pytest-xdist==2.3.0
 python-constraint==1.4.0
-python-dateutil==2.8.1
+python-dateutil==2.8.2
 pytz==2021.1
 pyyaml==5.4.1
 pyzmq==22.1.0
-qrules==0.9.0
+qrules==0.9.1
 radon==5.0.1
 regex==2021.7.6
-requests==2.25.1
+requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
+rich==10.6.0
 send2trash==1.7.1
 six==1.16.0
 smmap==4.0.0
@@ -180,7 +184,7 @@ traitlets==5.0.5
 types-docutils==0.1.7
 typing-extensions==3.10.0.0
 urllib3==1.26.6
-virtualenv==20.4.7
+virtualenv==20.5.0
 wcwidth==0.2.5
 webencodings==0.5.1
 websocket-client==1.1.0

diff --git a/.constraints/py3.9.txt b/.constraints/py3.9.txt
@@ -14,15 +14,17 @@ async-generator==1.10
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
+backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
 black==21.6b0
 bleach==3.3.0
 certifi==2021.5.30
 cffi==1.14.6
 cfgv==3.3.0
-chardet==4.0.0
+charset-normalizer==2.0.1
 click==8.0.1
 colorama==0.4.4
+commonmark==0.9.1
 coverage==5.5
 cycler==0.10.0
 debugpy==1.3.0
@@ -47,10 +49,10 @@ future==0.18.2
 gitdb==4.0.7
 gitpython==3.1.18
 gprof2dot==2021.2.21
-graphviz==0.16
+graphviz==0.17
 hepunits==2.1.1
 identify==2.2.11
-idna==2.10
+idna==3.2
 imagesize==1.2.0
 importlib-metadata==4.6.1
 importlib-resources==5.2.0
@@ -113,6 +115,7 @@ pexpect==4.8.0
 pickleshare==0.7.5
 pillow==8.3.1
 pip-tools==6.2.0
+platformdirs==2.0.2
 pluggy==0.13.1
 pre-commit==2.13.0
 prometheus-client==0.11.0
@@ -137,16 +140,17 @@ pytest-notebook==0.6.1
 pytest-profiling==1.7.0
 pytest-xdist==2.3.0
 python-constraint==1.4.0
-python-dateutil==2.8.1
+python-dateutil==2.8.2
 pytz==2021.1
 pyyaml==5.4.1
 pyzmq==22.1.0
-qrules==0.9.0
+qrules==0.9.1
 radon==5.0.1
 regex==2021.7.6
-requests==2.25.1
+requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
+rich==10.6.0
 send2trash==1.7.1
 six==1.16.0
 smmap==4.0.0
@@ -180,7 +184,7 @@ traitlets==5.0.5
 types-docutils==0.1.7
 typing-extensions==3.10.0.0
 urllib3==1.26.6
-virtualenv==20.4.7
+virtualenv==20.5.0
 wcwidth==0.2.5
 webencodings==0.5.1
 websocket-client==1.1.0

diff --git a/.cspell.json b/.cspell.json
@@ -156,6 +156,7 @@
         "heurisch",
         "imag",
         "iplt",
+        "ipykernel",
         "ipyplot",
         "ipywidgets",
         "isfunction",
@@ -166,6 +167,7 @@
         "katex",
         "kernelspec",
         "kmatrix",
+        "kutschke",
         "kwargs",
         "linestyle",
         "linewidth",
@@ -185,6 +187,7 @@
         "nbsphinx",
         "ndarray",
         "noqa",
+        "nowrap",
         "nrows",
         "nsimplify",
         "numpycode",
@@ -202,6 +205,7 @@
         "pyproject",
         "pyright",
         "pytestconfig",
+        "richman",
         "rightarrow",
         "risch",
         "rtfd",

diff --git a/docs/bibliography.bib b/docs/bibliography.bib
@@ -47,6 +47,16 @@ @article{chungPartialWaveAnalysis1995
   number = {5}
 }
 
+@techreport{chungSpinFormalismsUpdated2014,
+  title = {Spin {{Formalisms}} ({{Updated Version}})},
+  author = {Chung, Suh-Urk},
+  year = {2014},
+  month = jul,
+  pages = {BNL--76975-2006-IR, 890945},
+  institution = {{Brookhaven National Laboratory}},
+  url = {https://suchung.web.cern.ch/spinfm1.pdf}
+}
+
 @article{flatteCoupledchannelAnalysisPi1976,
   title = {Coupled-Channel Analysis of the Πη and {{KK̄}} Systems near {{KK̄}} Threshold},
   author = {Flatté, S.M.},
@@ -61,6 +71,14 @@ @article{flatteCoupledchannelAnalysisPi1976
   number = {2}
 }
 
+@misc{kutschkeAngularDistributionCookbook1996,
+  title = {An {{Angular Distribution Cookbook}}},
+  author = {Kutschke, Rob},
+  year = {1996},
+  month = jan,
+  url = {https://home.fnal.gov/~kutschke/Angdist/angdist.ps}
+}
+
 @misc{meyerMatrixTutorial2008,
   title = {A 𝐾-{{Matrix Tutorial}}},
   author = {Meyer, Curtis A.},
@@ -79,4 +97,12 @@ @phdthesis{pychyGekoppeltePartialwellenanalyseAnnihilationen2016
   school = {Ruhr-Universität Bochum}
 }
 
+@misc{richmanExperimenterGuideHelicity1984,
+  title = {An {{Experimenter}}'s {{Guide}} to the {{Helicity Formalism}}},
+  author = {Richman, Jeffrey D.},
+  year = {1984},
+  month = jun,
+  url = {https://inspirehep.net/literature/202987}
+}
+
 
diff --git a/docs/usage.md b/docs/usage.md
@@ -11,5 +11,6 @@ maxdepth: 2
 usage/amplitude
 usage/modify
 usage/interactive
+usage/formalism
 usage/dynamics
 ```