DOC: add page about symbolic amplitude models (#238)

Co-authored-by: Miriam Fritsch <67281455+miriamfritsch@users.noreply.github.com>

.cspell.json

@@ -61,8 +61,10 @@
     "autograd",
     "blatt",
     "breit",
+    "chromodynamics",
     "compwa",
     "conda",
+    "Curvenote",
     "Dalitz",
     "deadsnakes",
     "defaultdict",
@@ -84,12 +86,14 @@
     "lambdifying",
     "LHCb",
     "lineshape",
+    "Mathematica",
     "MathML",
     "matplotlib",
     "Mikhasenko",
     "miniconda",
     "mkdir",
     "mypy",
+    "Numba",
     "numpy",
     "parametrizations",
     "pathlib",
@@ -99,6 +103,7 @@
     "pytest",
     "PYTHONHASHSEED",
     "qrules",
+    "Reana",
     "roadmap",
     "Scikit",
     "scipy",
@@ -108,6 +113,7 @@
     "tensorwaves",
     "textwrap",
     "toolkits",
+    "TPUs",
     "traceback",
     "unbinned",
     "unitarity",
@@ -163,6 +169,7 @@
     "coolwarm",
     "csqrt",
     "cstride",
+    "cxxcode",
     "dalitzplot",
     "darkred",
     "dasharray",
@@ -182,6 +189,7 @@
     "expertsystem",
     "facecolor",
     "facecolors",
+    "fcode",
     "figsize",
     "filterwarnings",
     "fontcolor",
@@ -258,6 +266,7 @@
     "ndarray",
     "nonlocal",
     "nonumber",
+    "nopython",
     "noqa",
     "noreply",
     "nrows",
@@ -293,6 +302,7 @@
     "relim",
     "repr",
     "richman",
+    "royalblue",
     "rpartition",
     "rstride",
     "rstrip",
@@ -332,6 +342,7 @@
     "tickvals",
     "timeit",
     "toctree",
+    "toprettyxml",
     "tqdm",
     "treewise",
     "unevaluatable",

docs/conf.py

@@ -113,6 +113,7 @@ def get_nb_exclusion_patterns() -> list[str]:
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
     "sphinx_api_relink",
     "sphinx_codeautolink",
     "sphinx_comments",
@@ -126,6 +127,9 @@ def get_nb_exclusion_patterns() -> list[str]:
     "sphinxcontrib.bibtex",
 ]
 graphviz_output_format = "svg"
+html_css_files = [
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css",
+]
 html_favicon = "_static/favicon.ico"
 html_js_files = [
     "https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js",
@@ -186,6 +190,7 @@ def get_nb_exclusion_patterns() -> list[str]:
         f"https://mpl-interactions.readthedocs.io/en/{pin('mpl-interactions')}",
         None,
     ),
+    "numba": ("https://numba.pydata.org/numba-doc/latest", None),
     "numpy": (f"https://numpy.org/doc/{pin_minor('numpy')}", None),
     "plotly": ("https://plotly.com/python-api-reference/", None),
     "pwa": ("https://pwa.readthedocs.io", None),
@@ -195,6 +200,7 @@ def get_nb_exclusion_patterns() -> list[str]:
     "scipy": ("https://docs.scipy.org/doc/scipy-1.7.0", None),
     "sympy": ("https://docs.sympy.org/latest", None),
     "tensorwaves": ("https://tensorwaves.readthedocs.io/stable", None),
+    "torch": ("https://pytorch.org/docs/stable", None),
     "zfit": ("https://zfit.readthedocs.io/en/latest", None),
 }
 linkcheck_anchors = False
@@ -211,6 +217,7 @@ def get_nb_exclusion_patterns() -> list[str]:
     "https://mybinder.org",  # often instable
     "https://open.vscode.dev",
     "https://rosettacode.org",
+    "https://stackoverflow.com",
     "https://via.placeholder.com",  # irregular timeout
     "https://www.andiamo.co.uk/resources/iso-language-codes",  # 443, but works
     "https://www.bookfinder.com",
@@ -264,3 +271,4 @@ def get_nb_exclusion_patterns() -> list[str]:
     "repository_url": html_theme_options["repository_url"],
     "repository_branch": html_theme_options["repository_branch"],
 }
+todo_include_todos = True

docs/index.md

@@ -8,21 +8,21 @@
 {{ '[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/compwa.github.io/blob/{})'.format(branch) }} {{ '[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ComPWA/compwa.github.io/{}?filepath=docs/usage)'.format(branch) }}
 <!-- prettier-ignore-end -->
 
-The ["Common Partial Wave Analysis"](https://github.com/ComPWA) organization (ComPWA)
-aims to make amplitude analysis accessible through transparent and interactive
-documentation, modern software development tools, and collaboration-independent
-frameworks. **Contact details** can be found [here](https://github.com/ComPWA).
+The ["Common Partial Wave Analysis"](https://github.com/ComPWA) organization (ComPWA) aims to make amplitude analysis accessible through transparent and interactive documentation, modern software development tools, and collaboration-independent frameworks. One major novelty is that we [formulate amplitude models symbolically](./symbolics.ipynb) with a Computer Algebra System, which results in a **self-documenting workflow** with high-performance, **backend-agnostic computations**.
+
+Contact details can be found [here](https://github.com/ComPWA) on our GitHub organization page.
+
+:::{card} {material-outlined}`calculate;1.5em` Symbolic amplitude models
+:link: symbolics
+:link-type: doc
+Read more about computations with symbolic amplitude models here.
+:::
 
 ## Main projects
 
-ComPWA maintains **three main Python packages** with which you can do a full partial
-wave analysis. The packages are designed as **libraries**, so that they can be used
-separately by other projects.
+ComPWA maintains **three main Python packages** with which you can do a full partial wave analysis. The packages are designed as **libraries**, so that they can be used separately by other projects.
 
-Each of these libraries come with **interactive and interlinked documentation** that is
-intended to bring theory and code closer together. The PWA Pages takes that one step
-further: it is an independent and easy-to-maintain documentation project that can serve
-as a central place to gather links to PWA theory and software.
+Each of these libraries come with **interactive and interlinked documentation** that is intended to bring theory and code closer together. The PWA Pages takes that one step further: it is an independent and easy-to-maintain documentation project that can serve as a central place to gather links to PWA theory and software.
 
 <!-- prettier-ignore -->
 ::::{grid} 1 2 2 2
@@ -253,6 +253,7 @@ more about our ideals and ongoing projects on the {doc}`main</index>` page.
 caption: Resources
 hidden:
 ---
+symbolics
 develop
 adr
 reports

docs/report/024.ipynb

@@ -48,7 +48,7 @@
     ":::{card} Symbolic expressions and model serialization\n",
     "TR-024\n",
     "^^^\n",
-    "<!--- cspell:ignore COMAP cxxcode dodgerblue dummify fcode fillcolor indianred royalblue srepr toprettyxml --->\n",
+    "<!--- cspell:ignore COMAP dodgerblue dummify fillcolor indianred srepr --->\n",
     "Investigation into dumping SymPy expressions to human-readable format for model preservation. The notebook was motivated by the [COMAP-V workshop on analysis preservation](https://indico.cern.ch/event/1348003/). See also SymPy [printing](https://docs.sympy.org/latest/modules/printing.html), [parsing](https://docs.sympy.org/latest/modules/parsing.html), and [expression manipulation](https://docs.sympy.org/latest/tutorials/intro-tutorial/manipulation.html).\n",
     "+++\n",
     "🚧&nbsp;[polarimetry#319](https://github.com/ComPWA/polarimetry/pull/319)\n",