From d6acad851468a704e9cc686b5a3f1b4a55188ca7 Mon Sep 17 00:00:00 2001
From: Remco de Boer <29308176+redeboer@users.noreply.github.com>
Date: Mon, 30 Sep 2024 20:26:36 +0200
Subject: [PATCH] FIX: prevent TR-028 (PDG API) from running (#294)

* MAINT: freeze cell output of TR-028
* MAINT: update TR-028 to `pdg` v0.1.2
---
 .cspell.json          |   1 +
 docs/conf.py          |   1 +
 docs/report/028.ipynb | 265 ++++++++++++++++++++++++++++++++++++++----
 3 files changed, 244 insertions(+), 23 deletions(-)

diff --git a/.cspell.json b/.cspell.json
index 0bc911ea..291b3d52 100644
--- a/.cspell.json
+++ b/.cspell.json
@@ -317,6 +317,7 @@
     "numpycode",
     "operatorname",
     "pandoc",
+    "pbar",
     "pcolormesh",
     "pdg's",
     "phasespace",
diff --git a/docs/conf.py b/docs/conf.py
index 25b5c07f..135b3222 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -44,6 +44,7 @@ def get_nb_exclusion_patterns() -> list[str]:
         "report/020*",
         "report/021*",
         "report/022*",
+        "report/028*",
         "report/033*",
     }
     julia_notebooks = {
diff --git a/docs/report/028.ipynb b/docs/report/028.ipynb
index d5728a27..89add1d7 100644
--- a/docs/report/028.ipynb
+++ b/docs/report/028.ipynb
@@ -44,7 +44,7 @@
    },
    "outputs": [],
    "source": [
-    "%pip install -q pdg==0.0.6 tqdm==4.66.2"
+    "%pip install -q pdg==0.1.2 tqdm==4.66.5"
    ]
   },
   {
@@ -81,8 +81,28 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": [
+     "keep_output"
+    ]
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{pdg.data.PdgLifetime,\n",
+       " pdg.data.PdgMass,\n",
+       " pdg.data.PdgProperty,\n",
+       " pdg.data.PdgWidth,\n",
+       " pdg.decay.PdgBranchingFraction,\n",
+       " pdg.particle.PdgParticleList}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "{type(obj) for obj in PDG.get_all()}"
    ]
@@ -97,8 +117,23 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": [
+     "keep_output"
+    ]
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "pdg.decay.PdgBranchingFraction"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "jpsi_decay = PDG.get(\"M070.313/2023\")\n",
     "type(jpsi_decay)"
@@ -107,8 +142,23 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": [
+     "keep_output"
+    ]
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'J/psi(1S) --> rho(1700) pi --> pi+ pi- pi0'"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "jpsi_decay.description"
    ]
@@ -123,8 +173,23 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": [
+     "keep_output"
+    ]
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "7243"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "from pdg.decay import PdgBranchingFraction\n",
     "\n",
@@ -159,10 +224,22 @@
      "source_hidden": true
     },
     "tags": [
-     "hide-input"
+     "hide-input",
+     "keep_output"
     ]
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "7360"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "def create_final_state(description: str) -> tuple[str, ...]:\n",
     "    items = []\n",
@@ -199,8 +276,23 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": [
+     "keep_output"
+    ]
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "2181"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "three_body_decays = {\n",
     "    (initial_state, final_state)\n",
@@ -213,8 +305,38 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": [
+     "keep_output"
+    ]
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[('B0', ('K0S', 'K0S', 'K0S')),\n",
+       " ('B0', ('a', 'a', 'a')),\n",
+       " ('B_s()0', ('a', 'a', 'a')),\n",
+       " ('B_s()0', ('phi', 'phi', 'phi')),\n",
+       " ('J/psi(1S)', ('g', 'g', 'g')),\n",
+       " ('J/psi(1S)', ('gamma', 'gamma', 'gamma')),\n",
+       " ('Upsilon(1S)', ('g', 'g', 'g')),\n",
+       " ('Upsilon(2S)', ('g', 'g', 'g')),\n",
+       " ('Upsilon(3S)', ('g', 'g', 'g')),\n",
+       " ('Z', ('g', 'g', 'g')),\n",
+       " ('Z', ('gamma', 'gamma', 'gamma')),\n",
+       " ('a_1(1260)', ('pi0', 'pi0', 'pi0')),\n",
+       " ('a_1(1640)', ('pi', 'pi', 'pi')),\n",
+       " ('pi_1(1600)', ('pi', 'pi', 'pi')),\n",
+       " ('pi_2(1670)', ('pi0', 'pi0', 'pi0')),\n",
+       " ('psi(2S)', ('g', 'g', 'g'))]"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "equal_state_3body_decays = {\n",
     "    (initial_state, final_state)\n",
@@ -239,16 +361,34 @@
      "source_hidden": true
     },
     "tags": [
-     "hide-input"
+     "hide-input",
+     "keep_output"
     ]
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "           J/psi(1S) → g g g\n",
+      "           J/psi(1S) → gamma gamma gamma\n",
+      "         Upsilon(1S) → g g g\n",
+      "         Upsilon(2S) → g g g\n",
+      "         Upsilon(3S) → g g g\n",
+      "                   Z → g g g\n",
+      "                   Z → gamma gamma gamma\n",
+      "             psi(2S) → g g g\n"
+     ]
+    }
+   ],
    "source": [
+    "from pdg.errors import PdgAmbiguousValueError, PdgNoDataError\n",
+    "\n",
     "for initial_state, final_state in sorted(equal_state_3body_decays):\n",
     "    try:\n",
     "        for name in (initial_state, *final_state):\n",
     "            PDG.get_particle_by_name(name)\n",
-    "    except ValueError:\n",
+    "    except (PdgAmbiguousValueError, PdgNoDataError):\n",
     "        pass\n",
     "    else:\n",
     "        print(f\"{initial_state:>20} → {' '.join(final_state)}\")"
@@ -266,8 +406,36 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": [
+     "keep_output"
+    ]
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['a_1(1260) --> K^*(892) K',\n",
+       " 'a_1(1260) --> ( rho(1450) pi )(S-wave) , rho --> pi pi',\n",
+       " 'a_1(1260) --> f_2(1270) pi , f_2() --> pi pi',\n",
+       " 'a_1(1260) --> f_0(500) pi , f_0() --> pi pi',\n",
+       " 'a_1(1260) --> f_0(980) pi , f_0() --> pi pi',\n",
+       " 'a_1(1260) --> pi0 pi0 pi0',\n",
+       " 'a_1(1260) --> pi+ pi- pi0',\n",
+       " 'a_1(1260) --> ( rho(1450) pi )(D-wave) , rho --> pi pi',\n",
+       " 'a_1(1260) --> pi gamma',\n",
+       " 'a_1(1260) --> ( rho pi )(D-wave) , rho --> pi pi',\n",
+       " 'a_1(1260) --> 3 pi',\n",
+       " 'a_1(1260) --> f_0(1370) pi , f_0() --> pi pi',\n",
+       " 'a_1(1260) --> K K pi',\n",
+       " 'a_1(1260) --> ( rho pi )(S-wave) , rho --> pi pi']"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "[dec for dec in decay_descriptions if dec.startswith(\"a_1(1260)\")]"
    ]
@@ -287,10 +455,61 @@
      "source_hidden": true
     },
     "tags": [
-     "hide-input"
+     "hide-input",
+     "keep_output"
     ]
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['J/psi(1S) --> 2(pi+ pi- pi0)',\n",
+       " 'J/psi(1S) --> 2(pi+ pi- pi0) eta',\n",
+       " 'J/psi(1S) --> 2(pi+ pi-) 3pi0',\n",
+       " 'J/psi(1S) --> 2(pi+ pi-) pi0',\n",
+       " 'J/psi(1S) --> 3(pi+ pi-) pi0',\n",
+       " 'J/psi(1S) --> 4(pi+ pi-) pi0',\n",
+       " 'J/psi(1S) --> K+ K- pi0 pi0 pi0',\n",
+       " 'J/psi(1S) --> K0S K+- pi-+ pi+ pi-',\n",
+       " 'J/psi(1S) --> K0S K+- pi-+ pi0 pi0',\n",
+       " 'J/psi(1S) --> K^*(892)+ K0S pi- + c.c. --> K0S K0S pi+ pi-',\n",
+       " 'J/psi(1S) --> K^*(892)0 K- pi+ + c.c. --> K+ K- pi+ pi-',\n",
+       " 'J/psi(1S) --> K_2^*(1430)0 K- pi+ + c.c. --> K+ K- pi+ pi-',\n",
+       " 'J/psi(1S) --> a_2(1320)+ pi- pi0 + c.c --> 2 (pi+ pi- ) pi0',\n",
+       " 'J/psi(1S) --> a_2(1320)0 pi+ pi- --> 2 (pi+ pi- ) pi0',\n",
+       " 'J/psi(1S) --> eta pi+ pi- 3 pi0',\n",
+       " 'J/psi(1S) --> eta pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> gamma pi+ pi- 2pi0',\n",
+       " 'J/psi(1S) --> omega 3 pi0',\n",
+       " 'J/psi(1S) --> omega pi+ pi+ pi- pi-',\n",
+       " 'J/psi(1S) --> omega pi+ pi- 2pi0',\n",
+       " 'J/psi(1S) --> omega pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> omega pi0 --> pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> p pbar pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> phi f_1(1285) --> phi pi0 f_0(980) --> phi 3pi0',\n",
+       " 'J/psi(1S) --> phi f_1(1285) --> phi pi0 f_0(980) --> phi pi0 pi+ pi-',\n",
+       " 'J/psi(1S) --> phi pi0 f_0(980) --> phi pi0 p0 pi0',\n",
+       " 'J/psi(1S) --> phi pi0 f_0(980) --> phi pi0 pi+ pi-',\n",
+       " 'J/psi(1S) --> pi+ pi- 3pi0',\n",
+       " 'J/psi(1S) --> pi+ pi- 4 pi0',\n",
+       " 'J/psi(1S) --> pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> pi+ pi- pi0 K+ K-',\n",
+       " 'J/psi(1S) --> pi+ pi- pi0 pi0 eta',\n",
+       " 'J/psi(1S) --> rho(1450) pi --> pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> rho(1700) pi --> pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> rho(2150) pi --> pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> rho+ K+ K- pi- + c.c --> K+ K- pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> rho+ rho- pi+ pi- pi0',\n",
+       " 'J/psi(1S) --> rho+- pi-+ pi+ pi- 2pi0',\n",
+       " 'J/psi(1S) --> rho+- pi-+ pi0 pi0',\n",
+       " 'J/psi(1S) --> rho_3(1690) pi --> pi+ pi- pi0']"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "import re\n",
     "\n",
@@ -321,7 +540,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.14"
+   "version": "3.12.6"
   }
  },
  "nbformat": 4,