From e8be651638da8345e7973fb483d6f580bd78c475 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Tue, 23 Apr 2024 15:15:34 +0200 Subject: [PATCH] ENH: render particle name in Markdown as code (#105) * DOC: hide `RuntimeWarning`s * DOC: widen DPD intensity expression cell * DX: remove redundant notebook metadata * FIX: conserve parity in production node * FIX: remove `sphinx.ext.viewcode` extensions --- .cspell.json | 1 + .pre-commit-config.yaml | 4 +++- docs/comparison/d2kkk.ipynb | 3 +++ docs/comparison/jpsi2phipipi.ipynb | 3 +++ docs/comparison/jpsi2pipipi.ipynb | 3 +++ docs/conf.py | 1 - docs/jpsi2ksp.ipynb | 2 +- src/ampform_dpd/io.py | 2 +- 8 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.cspell.json b/.cspell.json index 4a176149..0f353a25 100644 --- a/.cspell.json +++ b/.cspell.json @@ -103,6 +103,7 @@ "seealso", "setuptools", "sharey", + "simplefilter", "startswith", "suptitle", "textwrap", diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2dee43d6..e75925a0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -21,8 +21,10 @@ repos: - | cell.attachments cell.metadata.code_folding + cell.metadata.editable cell.metadata.id cell.metadata.pycharm + cell.metadata.slideshow cell.metadata.user_expressions metadata.celltoolbar metadata.colab.name @@ -38,7 +40,7 @@ repos: metadata.vscode - repo: https://github.com/ComPWA/policy - rev: 0.3.4 + rev: 0.3.6 hooks: - id: check-dev-files args: diff --git a/docs/comparison/d2kkk.ipynb b/docs/comparison/d2kkk.ipynb index c20d9478..79fc5055 100644 --- a/docs/comparison/d2kkk.ipynb +++ b/docs/comparison/d2kkk.ipynb @@ -34,6 +34,7 @@ "import itertools\n", "import logging\n", "import os\n", + "import warnings\n", "from textwrap import dedent\n", "from typing import TYPE_CHECKING, Iterable\n", "\n", @@ -82,6 +83,7 @@ "simplify_latex_rendering()\n", "logging.getLogger(\"jax\").setLevel(logging.ERROR) # mute JAX\n", "os.environ[\"TF_CPP_MIN_LOG_LEVEL\"] = \"3\" # mute TF\n", + "warnings.simplefilter(\"ignore\")\n", "NO_TQDM = \"EXECUTE_NB\" in os.environ\n", "if NO_TQDM:\n", " logging.getLogger(\"ampform.sympy\").setLevel(logging.ERROR)\n", @@ -311,6 +313,7 @@ "source_hidden": true }, "tags": [ + "full-width", "hide-input" ] }, diff --git a/docs/comparison/jpsi2phipipi.ipynb b/docs/comparison/jpsi2phipipi.ipynb index 515edad3..368767af 100644 --- a/docs/comparison/jpsi2phipipi.ipynb +++ b/docs/comparison/jpsi2phipipi.ipynb @@ -34,6 +34,7 @@ "import itertools\n", "import logging\n", "import os\n", + "import warnings\n", "from textwrap import dedent\n", "from typing import TYPE_CHECKING, Iterable\n", "\n", @@ -82,6 +83,7 @@ "simplify_latex_rendering()\n", "logging.getLogger(\"jax\").setLevel(logging.ERROR) # mute JAX\n", "os.environ[\"TF_CPP_MIN_LOG_LEVEL\"] = \"3\" # mute TF\n", + "warnings.simplefilter(\"ignore\")\n", "NO_TQDM = \"EXECUTE_NB\" in os.environ\n", "if NO_TQDM:\n", " logging.getLogger(\"ampform.sympy\").setLevel(logging.ERROR)\n", @@ -301,6 +303,7 @@ "source_hidden": true }, "tags": [ + "full-width", "hide-input" ] }, diff --git a/docs/comparison/jpsi2pipipi.ipynb b/docs/comparison/jpsi2pipipi.ipynb index eeb7de4c..caccab7b 100644 --- a/docs/comparison/jpsi2pipipi.ipynb +++ b/docs/comparison/jpsi2pipipi.ipynb @@ -34,6 +34,7 @@ "import itertools\n", "import logging\n", "import os\n", + "import warnings\n", "from textwrap import dedent\n", "from typing import TYPE_CHECKING, Iterable\n", "\n", @@ -82,6 +83,7 @@ "simplify_latex_rendering()\n", "logging.getLogger(\"jax\").setLevel(logging.ERROR) # mute JAX\n", "os.environ[\"TF_CPP_MIN_LOG_LEVEL\"] = \"3\" # mute TF\n", + "warnings.simplefilter(\"ignore\")\n", "NO_TQDM = \"EXECUTE_NB\" in os.environ\n", "if NO_TQDM:\n", " logging.getLogger(\"ampform.sympy\").setLevel(logging.ERROR)\n", @@ -301,6 +303,7 @@ "source_hidden": true }, "tags": [ + "full-width", "hide-input" ] }, diff --git a/docs/conf.py b/docs/conf.py index d77150b7..47dabb5a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -88,7 +88,6 @@ "sphinx.ext.githubpages", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", - "sphinx.ext.viewcode", "sphinx_api_relink", "sphinx_book_theme", "sphinx_codeautolink", diff --git a/docs/jpsi2ksp.ipynb b/docs/jpsi2ksp.ipynb index c7109f39..18e76cc4 100644 --- a/docs/jpsi2ksp.ipynb +++ b/docs/jpsi2ksp.ipynb @@ -180,7 +180,7 @@ " child1, child2, spectator = Σ, pbar, K\n", " else:\n", " raise NotImplementedError\n", - " prod_ls_couplings = _generate_ls(Jpsi, resonance, spectator, conserve_parity=False)\n", + " prod_ls_couplings = _generate_ls(Jpsi, resonance, spectator, conserve_parity=True)\n", " dec_ls_couplings = _generate_ls(resonance, child1, child2, conserve_parity=True)\n", " if min_ls:\n", " decay = IsobarNode(\n", diff --git a/src/ampform_dpd/io.py b/src/ampform_dpd/io.py index 9e89bb3a..e737ae63 100644 --- a/src/ampform_dpd/io.py +++ b/src/ampform_dpd/io.py @@ -173,7 +173,7 @@ def _as_resonance_markdown_table(items: Sequence[Particle]) -> str: src = _create_markdown_table_header(column_names) for particle in items: row_items = [ - particle.name, + f"`{particle.name}`", f"${particle.latex}$", Rf"${aslatex(particle, only_jp=True)}$", f"{int(1e3 * particle.mass):,.0f}",