Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FIX: update links to TRs
Browse files Browse the repository at this point in the history
redeboer committed Oct 28, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 2f442a7 commit a11aecc
Showing 10 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/_extend_docstrings.py
Original file line number Diff line number Diff line change
@@ -509,7 +509,7 @@ def extend_chew_mandelstam_s_wave() -> None:
with :math:`q^2(s)` defined as :eq:`BreakupMomentumSquared`.
.. seealso:: :doc:`compwa-report:003`
.. seealso:: :doc:`compwa-report:003/index`
""",
)

2 changes: 1 addition & 1 deletion docs/usage/dynamics/analytic-continuation.ipynb
Original file line number Diff line number Diff line change
@@ -63,7 +63,7 @@
"source": [
":::{note}\n",
"\n",
"Improvements to analytic continuation in AmpForm are currently being developed in {doc}`compwa-report:003` and {doc}`compwa-report:004`.\n",
"Improvements to analytic continuation in AmpForm are currently being developed in {doc}`compwa-report:003/index` and {doc}`compwa-report:004/index`.\n",
"\n",
":::"
]
4 changes: 2 additions & 2 deletions docs/usage/dynamics/k-matrix.ipynb
Original file line number Diff line number Diff line change
@@ -74,7 +74,7 @@
"\n",
":::{note}\n",
"\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",
"The $\\boldsymbol{K}$-matrix approach was originally worked worked out in {doc}`compwa-report:005/index`, {doc}`compwa-report:009/index`, and {doc}`compwa-report:010/index`. Those reports contained a few mistakes, which have been addressed here.\n",
"\n",
":::\n",
"\n",
@@ -331,7 +331,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-report:003` and {doc}`compwa-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/index` and {doc}`compwa-report:004/index`.\n",
"\n",
"With these definitions, we can deduce that:\n",
"\n",
4 changes: 2 additions & 2 deletions docs/usage/helicity/spin-alignment.ipynb
Original file line number Diff line number Diff line change
@@ -93,7 +93,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"As described in {doc}`compwa-report:015`, the {doc}`'standard' helicity formalism </usage/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/index`, the {doc}`'standard' helicity formalism </usage/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:"
]
@@ -388,7 +388,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"For more information about these angles, see {ref}`compwa-report:015:Compute Wigner rotation angles` in {doc}`TR-015 <compwa-report:015>`."
"For more information about these angles, see {ref}`compwa-report:015/index:Compute Wigner rotation angles` in {doc}`TR-015 <compwa-report:015/index>`."
]
}
],
4 changes: 2 additions & 2 deletions docs/usage/kinematics.ipynb
Original file line number Diff line number Diff line change
@@ -260,7 +260,7 @@
"metadata": {},
"source": [
":::{margin}\n",
"This notebook originates from {doc}`compwa-report:017`.\n",
"This notebook originates from {doc}`compwa-report:017/index`.\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",
@@ -384,7 +384,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"See {doc}`compwa-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/index` for an interactive visualization of the phase space region and an analytic expression for the phase space boundary."
]
}
],
4 changes: 2 additions & 2 deletions src/ampform/dynamics/form_factor.py
Original file line number Diff line number Diff line change
@@ -52,7 +52,7 @@ class BlattWeisskopfSquared(sp.Expr):
:pdg-review:`2021; Resonances; p.9`. We normalize the form factor such that
:math:`B_L^2(1)=1` and that :math:`B_L^2` is unitless no matter what :math:`z` is.
.. seealso:: :ref:`usage/dynamics:Form factor`, :doc:`TR-029<compwa-report:029>`,
.. seealso:: :ref:`usage/dynamics:Form factor`, :doc:`TR-029<compwa-report:029/index>`,
and :cite:`chungFormulasAngularMomentumBarrier2015`.
With this, the implementation becomes
@@ -94,7 +94,7 @@ def _formulate_blatt_weisskopf(ell, z) -> sp.Expr:
class SphericalHankel1(sp.Expr):
r"""Spherical Hankel function of the first kind for real-valued :math:`z`.
See :cite:`VonHippel:1972fg`, Equation (A12), and :doc:`TR-029<compwa-report:029>`
See :cite:`VonHippel:1972fg`, Equation (A12), and :doc:`TR-029<compwa-report:029/index>`
for more info. `This page
<https://mathworld.wolfram.com/SphericalHankelFunctionoftheFirstKind.html>`_
explains the difference with the *general* Hankel function of the first kind,
4 changes: 2 additions & 2 deletions src/ampform/dynamics/kmatrix.py
Original file line number Diff line number Diff line change
@@ -2,8 +2,8 @@
.. seealso:: :doc:`/usage/dynamics/k-matrix`.
This module is an implementation of :doc:`compwa-report:005`,
:doc:`compwa-report:009`, and :doc:`compwa-report:010`. It works with classes to
This module is an implementation of :doc:`compwa-report:005/index`,
:doc:`compwa-report:009/index`, and :doc:`compwa-report:010/index`. 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.
"""
2 changes: 1 addition & 1 deletion src/ampform/sympy/deprecated.py
Original file line number Diff line number Diff line change
@@ -31,7 +31,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-report:001`).
:doc:`compwa-report:001/index`).
The `UnevaluatedExpression` base class makes implementations of its derived classes
more secure by enforcing the developer to provide implementations for these methods,
2 changes: 1 addition & 1 deletion src/ampform/sympy/math.py
Original file line number Diff line number Diff line change
@@ -26,7 +26,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-report:000`, :doc:`compwa-report:001`, and
:doc:`compwa-report:000/index`, :doc:`compwa-report:001/index`, and
:doc:`sympy:modules/printing` for how to implement a custom
:func:`~sympy.utilities.lambdify.lambdify` printer.
"""
2 changes: 1 addition & 1 deletion src/symplot/__init__.py
Original file line number Diff line number Diff line change
@@ -382,7 +382,7 @@ def rename_symbols(
def substitute_indexed_symbols(expression: sp.Expr) -> sp.Expr:
"""Substitute `~sympy.tensor.indexed.IndexedBase` with symbols.
See :doc:`compwa-report:008` for more info.
See :doc:`compwa-report:008/index` for more info.
"""
return expression.xreplace({
s: _indexed_to_symbol(s)

0 comments on commit a11aecc

Please sign in to comment.