diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 227e16db6..eaf364270 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,4 @@ [![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/ampform) [![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/ampform) -This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more -information about how to contribute to the packages, go to -[compwa-org.rtfd.io/en/stable/develop.html](https://compwa-org.rtfd.io/en/stable/develop.html)! +This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to [compwa.github.io/develop](https://compwa.github.io/develop)! diff --git a/docs/_extend_docstrings.py b/docs/_extend_docstrings.py index 7028ddb20..0cda15306 100644 --- a/docs/_extend_docstrings.py +++ b/docs/_extend_docstrings.py @@ -505,7 +505,7 @@ def extend_chew_mandelstam_s_wave() -> None: with :math:`q^2(s)` defined as :eq:`BreakupMomentumSquared`. - .. seealso:: :doc:`compwa-org:report/003` + .. seealso:: :doc:`compwa:report/003` """, ) diff --git a/docs/conf.py b/docs/conf.py index e477fefa4..cfd8915b4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -170,7 +170,7 @@ "icon_links": [ { "name": "Common Partial Wave Analysis", - "url": "https://compwa-org.rtfd.io", + "url": "https://compwa.github.io", "icon": "_static/favicon.ico", "type": "local", }, @@ -227,7 +227,7 @@ intersphinx_mapping = { "IPython": (f"https://ipython.readthedocs.io/en/{pin('IPython')}", None), "attrs": (f"https://www.attrs.org/en/{pin('attrs')}", None), - "compwa-org": ("https://compwa-org.readthedocs.io", None), + "compwa": ("https://compwa.github.io", None), "graphviz": ("https://graphviz.readthedocs.io/en/stable", None), "ipywidgets": (f"https://ipywidgets.readthedocs.io/en/{pin('ipywidgets')}", None), "matplotlib": (f"https://matplotlib.org/{pin('matplotlib')}", None), @@ -266,7 +266,7 @@ "run_interactive": f""" ```{{margin}} Run this notebook [on Binder]({BINDER_LINK}) or -{{ref}}`locally on Jupyter Lab ` to interactively +{{ref}}`locally on Jupyter Lab ` to interactively modify the parameters. ``` """, diff --git a/docs/index.md b/docs/index.md index 6a4e2a36f..cc4ffa7ab 100644 --- a/docs/index.md +++ b/docs/index.md @@ -79,7 +79,7 @@ maxdepth: 2 API Changelog Upcoming features -Help developing +Help developing ``` ```{toctree} @@ -90,5 +90,5 @@ hidden: QRules TensorWaves PWA Pages -ComPWA project +ComPWA project ``` diff --git a/docs/install.md b/docs/install.md index 0ebaf81da..f5434a547 100644 --- a/docs/install.md +++ b/docs/install.md @@ -33,7 +33,7 @@ can find on the [`stable`](https://github.com/ComPWA/ampform/tree/stable) branch Optionally, you can install the dependencies required for {doc}`visualizing topologies ` with the following -{ref}`optional dependency syntax `: +{ref}`optional dependency syntax `: ```shell pip install ampform[viz] # installs ampform with graphviz @@ -49,13 +49,13 @@ python3 -m pip install git+https://github.com/ComPWA/ampform@main ## Editable installation It is highly recommend to use the more dynamic -{ref}`'editable installation' `. This allows +{ref}`'editable installation' `. This allows you to: -- exactly {ref}`pin all dependencies ` +- exactly {ref}`pin all dependencies ` to a specific version, so that your work is **reproducible**. - edit the source code of the framework and - {doc}`help improving it `. + {doc}`help improving it `. For this, you first need to get the source code with [Git](https://git-scm.com): @@ -85,11 +85,11 @@ This installs the project in a Conda environment following the definitions in 1. **[Recommended]** Create a virtual environment with [`venv`](https://docs.python.org/3/library/venv.html) (see - {ref}`here `). + {ref}`here `). 2. Install the project as an - {ref}`'editable installation' ` with - {ref}`additional packages ` for the + {ref}`'editable installation' ` with + {ref}`additional packages ` for the developer and all dependencies pinned through [constraints files](https://pip.pypa.io/en/stable/user_guide/#constraints-files): @@ -101,9 +101,9 @@ This installs the project in a Conda environment following the definitions in :::: -See {ref}`compwa-org:develop:Updating` for how to update the dependencies when new +See {ref}`compwa:develop:Updating` for how to update the dependencies when new commits come in. That's all! Have a look at {doc}`/usage` to try out the package. You can also have a -look at {doc}`compwa-org:develop` for tips on how to work with this 'editable' developer +look at {doc}`compwa:develop` for tips on how to work with this 'editable' developer setup! diff --git a/docs/usage/dynamics/analytic-continuation.ipynb b/docs/usage/dynamics/analytic-continuation.ipynb index 7b94fd021..97bd7302f 100644 --- a/docs/usage/dynamics/analytic-continuation.ipynb +++ b/docs/usage/dynamics/analytic-continuation.ipynb @@ -69,7 +69,7 @@ "source": [ ":::{note}\n", "\n", - "Improvements to analytic continuation in AmpForm are currently being developed in {doc}`compwa-org:report/003` and {doc}`compwa-org:report/004`.\n", + "Improvements to analytic continuation in AmpForm are currently being developed in {doc}`compwa:report/003` and {doc}`compwa:report/004`.\n", "\n", ":::" ] diff --git a/docs/usage/dynamics/k-matrix.ipynb b/docs/usage/dynamics/k-matrix.ipynb index c76742a96..d41353307 100644 --- a/docs/usage/dynamics/k-matrix.ipynb +++ b/docs/usage/dynamics/k-matrix.ipynb @@ -80,7 +80,7 @@ "\n", ":::{note}\n", "\n", - "The $\\boldsymbol{K}$-matrix approach was originally worked worked out in {doc}`compwa-org:report/005`, {doc}`compwa-org:report/009`, and {doc}`compwa-org:report/010`. Those reports contained a few mistakes, which have been addressed here.\n", + "The $\\boldsymbol{K}$-matrix approach was originally worked worked out in {doc}`compwa:report/005`, {doc}`compwa:report/009`, and {doc}`compwa:report/010`. Those reports contained a few mistakes, which have been addressed here.\n", "\n", ":::\n", "\n", @@ -345,7 +345,7 @@ "\\end{eqnarray}\n", "$$ (K-hat-and-T-hat)\n", "\n", - "[^rho-dagger]: An unpublished primer on the $\\boldsymbol{K}$-matrix by Chung {cite}`chungPrimerKmatrixFormalism1995` uses a conjugate transpose of $\\boldsymbol{\\rho}$, e.g. $\\boldsymbol{T} = \\sqrt{\\boldsymbol{\\rho^\\dagger}} \\; \\boldsymbol{\\hat{T}} \\sqrt{\\boldsymbol{\\rho}}$. This should not matter above threshold, where the phase space factor is real, but could have effects below threshold. This is where things become tricky: on the one hand, we need to ensure that $\\boldsymbol{K}$ remains real (unitarity) and on the other, we need to take keep track of which imaginary square root we choose (**Riemann sheet**). The latter is often called the requirement of **analyticity**. This is currently being explored in {doc}`compwa-org:report/003` and {doc}`compwa-org:report/004`.\n", + "[^rho-dagger]: An unpublished primer on the $\\boldsymbol{K}$-matrix by Chung {cite}`chungPrimerKmatrixFormalism1995` uses a conjugate transpose of $\\boldsymbol{\\rho}$, e.g. $\\boldsymbol{T} = \\sqrt{\\boldsymbol{\\rho^\\dagger}} \\; \\boldsymbol{\\hat{T}} \\sqrt{\\boldsymbol{\\rho}}$. This should not matter above threshold, where the phase space factor is real, but could have effects below threshold. This is where things become tricky: on the one hand, we need to ensure that $\\boldsymbol{K}$ remains real (unitarity) and on the other, we need to take keep track of which imaginary square root we choose (**Riemann sheet**). The latter is often called the requirement of **analyticity**. This is currently being explored in {doc}`compwa:report/003` and {doc}`compwa:report/004`.\n", "\n", "With these definitions, we can deduce that:\n", "\n", diff --git a/docs/usage/helicity/spin-alignment.ipynb b/docs/usage/helicity/spin-alignment.ipynb index cffd1be30..e880f5d04 100644 --- a/docs/usage/helicity/spin-alignment.ipynb +++ b/docs/usage/helicity/spin-alignment.ipynb @@ -98,7 +98,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "As described in {doc}`compwa-org:report/015`, the {doc}`'standard' helicity formalism ` is not suited for state transitions that have different decay topologies. For this reason, the {class}`.HelicityAmplitudeBuilder` can insert a number of Wigner-$D$ functions into the amplitude model to 'align' the final state spins of underlying {class}`~qrules.topology.Topology` instances in the full decay.\n", + "As described in {doc}`compwa:report/015`, the {doc}`'standard' helicity formalism ` is not suited for state transitions that have different decay topologies. For this reason, the {class}`.HelicityAmplitudeBuilder` can insert a number of Wigner-$D$ functions into the amplitude model to 'align' the final state spins of underlying {class}`~qrules.topology.Topology` instances in the full decay.\n", "\n", "Imagine we have the following the decay:" ] @@ -406,7 +406,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "For more information about these angles, see {ref}`compwa-org:report/015:Compute Wigner rotation angles` in {doc}`TR-015 `." + "For more information about these angles, see {ref}`compwa:report/015:Compute Wigner rotation angles` in {doc}`TR-015 `." ] } ], diff --git a/docs/usage/kinematics.ipynb b/docs/usage/kinematics.ipynb index a8b67e191..4930467f6 100644 --- a/docs/usage/kinematics.ipynb +++ b/docs/usage/kinematics.ipynb @@ -277,7 +277,7 @@ }, "source": [ ":::{margin}\n", - "This notebook originates from {doc}`compwa-org:report/017`.\n", + "This notebook originates from {doc}`compwa:report/017`.\n", ":::\n", "\n", "Kinematics for a three-body decay $0 \\to 123$ can be fully described by two **Mandelstam variables** $\\sigma_1, \\sigma_2$, because the third variable $\\sigma_3$ can be expressed in terms $\\sigma_1, \\sigma_2$, the mass $m_0$ of the initial state, and the masses $m_1, m_2, m_3$ of the final state. As can be seen, the roles of $\\sigma_1, \\sigma_2, \\sigma_3$ are interchangeable.\n", @@ -405,7 +405,7 @@ "tags": [] }, "source": [ - "See {doc}`compwa-org:report/017` for an interactive visualization of the phase space region and an analytic expression for the phase space boundary." + "See {doc}`compwa:report/017` for an interactive visualization of the phase space region and an analytic expression for the phase space boundary." ] } ], diff --git a/src/ampform/dynamics/kmatrix.py b/src/ampform/dynamics/kmatrix.py index f9115748c..ecacb0a2e 100644 --- a/src/ampform/dynamics/kmatrix.py +++ b/src/ampform/dynamics/kmatrix.py @@ -2,8 +2,8 @@ .. seealso:: :doc:`/usage/dynamics/k-matrix`. -This module is an implementation of :doc:`compwa-org:report/005`, -:doc:`compwa-org:report/009`, and :doc:`compwa-org:report/010`. It works with classes to +This module is an implementation of :doc:`compwa:report/005`, +:doc:`compwa:report/009`, and :doc:`compwa:report/010`. It works with classes to keep the code organized and to enable caching of the matrix multiplications, but this might change once these dynamics are implemented into the amplitude builder. """ diff --git a/src/ampform/helicity/__init__.py b/src/ampform/helicity/__init__.py index 8b8a84170..57fc4e2c3 100644 --- a/src/ampform/helicity/__init__.py +++ b/src/ampform/helicity/__init__.py @@ -116,7 +116,7 @@ class HelicityModel: helicity combination. These amplitudes are indicated with as `sp.Indexed ` instances and this attribute provides the definitions for each of these. See also - :ref:`TR-014 `. + :ref:`TR-014 `. """ parameter_defaults: ParameterValues = field(converter=_to_parameter_values) """A mapping of suggested parameter values. diff --git a/src/ampform/sympy/deprecated.py b/src/ampform/sympy/deprecated.py index 85e402dae..2b32a574d 100644 --- a/src/ampform/sympy/deprecated.py +++ b/src/ampform/sympy/deprecated.py @@ -26,7 +26,7 @@ class UnevaluatedExpression(sp.Expr): 1. condense the LaTeX representation of an expression tree by providing a custom :meth:`_latex` method. 2. overwrite its printer methods (see `.NumPyPrintable` and e.g. - :doc:`compwa-org:report/001`). + :doc:`compwa:report/001`). The `UnevaluatedExpression` base class makes implementations of its derived classes more secure by enforcing the developer to provide implementations for these methods, diff --git a/src/ampform/sympy/math.py b/src/ampform/sympy/math.py index d050472c2..526cb3d69 100644 --- a/src/ampform/sympy/math.py +++ b/src/ampform/sympy/math.py @@ -21,7 +21,7 @@ class ComplexSqrt(NumPyPrintable): A special version :func:`~sympy.functions.elementary.miscellaneous.sqrt` that renders nicely as LaTeX and and can be used as a handle for lambdify printers. See - :doc:`compwa-org:report/000`, :doc:`compwa-org:report/001`, and + :doc:`compwa:report/000`, :doc:`compwa:report/001`, and :doc:`sympy:modules/printing` for how to implement a custom :func:`~sympy.utilities.lambdify.lambdify` printer. """ diff --git a/src/symplot/__init__.py b/src/symplot/__init__.py index 1135a80f4..dcd068999 100644 --- a/src/symplot/__init__.py +++ b/src/symplot/__init__.py @@ -394,7 +394,7 @@ def rename_symbols( def substitute_indexed_symbols(expression: sp.Expr) -> sp.Expr: """Substitute `~sympy.tensor.indexed.IndexedBase` with symbols. - See :doc:`compwa-org:report/008` for more info. + See :doc:`compwa:report/008` for more info. """ return expression.xreplace({ s: _indexed_to_symbol(s) diff --git a/tests/kinematics/test_phasespace.py b/tests/kinematics/test_phasespace.py index 0c8d4b6ed..36f897e54 100644 --- a/tests/kinematics/test_phasespace.py +++ b/tests/kinematics/test_phasespace.py @@ -12,7 +12,7 @@ ], ) def test_is_within_phasespace(s1, s2, expected): - # See widget https://compwa-org.rtfd.io/report/017.html + # See widget https://compwa.github.io/report/017 m0 = 2.1 m1 = 0.2 m2 = 0.4