From 14352eb9a2edc656826c58f3f433b486106bd8b4 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 13 Jan 2024 15:38:35 +0100 Subject: [PATCH] MAINT: replace compwa-org with compwa.github.io --- .github/release-drafter.yml | 4 ++-- .pre-commit-config.yaml | 4 ++-- CITATION.cff | 4 ++-- CONTRIBUTING.md | 4 ++-- README.md | 13 ++++++------- docs/conf.py | 2 +- docs/develop.md | 6 +++--- docs/index.md | 4 ++-- docs/report/006.ipynb | 2 +- docs/report/011.ipynb | 2 +- docs/report/015.ipynb | 2 +- docs/report/017.ipynb | 2 +- docs/report/019.ipynb | 4 ++-- docs/report/020.ipynb | 2 +- docs/report/021.ipynb | 4 ++-- docs/report/022.ipynb | 12 ++++++------ docs/report/023.ipynb | 2 +- environment.yml | 2 +- pyproject.toml | 8 ++++---- 19 files changed, 41 insertions(+), 42 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index f63af10b..e427ab98 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -1,4 +1,4 @@ -name-template: ComPWA Organization Documentation $NEXT_PATCH_VERSION +name-template: ComPWA Organization $NEXT_PATCH_VERSION tag-template: $NEXT_PATCH_VERSION references: @@ -34,4 +34,4 @@ sort-direction: ascending template: | $CHANGES - _The full changelog as commits can be found [here](https://github.com/ComPWA/compwa-org/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._ + _The full changelog as commits can be found [here](https://github.com/ComPWA/compwa.github.io/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ff1ec802..99008f65 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -21,8 +21,8 @@ repos: - --github-pages - --no-prettierrc - --pin-requirements=bimonthly - - --repo-name=compwa-org - - --repo-title=ComPWA Organization Documentation + - --repo-name=compwa.github.io + - --repo-title=ComPWA Organization - id: colab-toc-visible - id: fix-nbformat-version - id: pin-nb-requirements diff --git a/CITATION.cff b/CITATION.cff index dda49207..6c21609e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -47,6 +47,6 @@ keywords: - partial wave analysis - computer algebra system license: GPL-3.0-or-later -repository-code: https://github.com/ComPWA/compwa-org +repository-code: https://github.com/ComPWA/compwa.github.io type: software -url: https://compwa-org.readthedocs.io +url: https://compwa.github.io diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f6aaa61..9368b24e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # How to contribute? -[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa-org) -[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa-org) +[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa.github.io) +[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa.github.io) This repository is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to diff --git a/README.md b/README.md index 4039045b..a86d0c67 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,16 @@ [![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html) [![Documentation build status](https://readthedocs.org/projects/pwa/badge/?version=latest)](https://pwa.readthedocs.io) -[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ComPWA/compwa-org/main) -[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/compwa-org/blob/main) -[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa-org) -[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa-org) -[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/compwa-org/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/compwa-org/main) +[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ComPWA/compwa.github.io/main) +[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/compwa.github.io/blob/main) +[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa.github.io) +[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa.github.io) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/compwa.github.io/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/compwa.github.io/main) [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -This repository contains the source code for the -[compwa-org.rtfd.io](https://compwa-org.readthedocs.io) pages. +This repository contains the source code for the [compwa.github.io](https://compwa.github.io) pages. diff --git a/docs/conf.py b/docs/conf.py index 9cf0d378..68c5b081 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -64,7 +64,7 @@ def get_nb_exclusion_patterns() -> list[str]: BRANCH = get_branch_name() ORGANIZATION = "ComPWA" -REPO_NAME = "compwa-org" +REPO_NAME = "compwa.github.io" REPO_TITLE = "ComPWA Organization" BINDER_LINK = ( diff --git a/docs/develop.md b/docs/develop.md index 809888f4..6ceb8138 100644 --- a/docs/develop.md +++ b/docs/develop.md @@ -1,7 +1,7 @@ # Help developing -[![GitPod](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa-org) -[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa-org) +[![GitPod](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa.github.io) +[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa.github.io) This page describes some of the tools and conventions followed by [Common Partial Wave Analysis](https://github.com/ComPWA). Where possible, we use the @@ -958,7 +958,7 @@ be familiar with. :::{margin} Do you have other recommendations? Edit this page -[here](https://github.com/ComPWA/compwa-org/edit/main/docs/develop.md)! +[here](https://github.com/ComPWA/compwa.github.io/edit/main/docs/develop.md)! ::: diff --git a/docs/index.md b/docs/index.md index 5487ebea..02068852 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,7 @@ ``` -{{ '[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/compwa-org/blob/{})'.format(branch) }} {{ '[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ComPWA/compwa-org/{}?filepath=docs/usage)'.format(branch) }} +{{ '[![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) }} The ["Common Partial Wave Analysis"](https://github.com/ComPWA) organization (ComPWA) @@ -97,7 +97,7 @@ A central knowledge-base for Partial Wave Analysis theory and software :::: Finally, the {doc}`technical reports ` on these pages -([compwa-org.rtfd.io](https://compwa-org.readthedocs.io)) describe more general tips and +([compwa.github.io](https://compwa.github.io)) describe more general tips and tricks, some of which can be of interest to general Python users as well! :::{dropdown} Deprecated projects diff --git a/docs/report/006.ipynb b/docs/report/006.ipynb index b3d0a840..fe821d03 100644 --- a/docs/report/006.ipynb +++ b/docs/report/006.ipynb @@ -469,7 +469,7 @@ "\n", "1. Set `continuous_update=False`, because {mod}`plotly` is slower than {mod}`matplotlib` in updating the figure.\n", "2. Save the camera orientation and update it after calling `Figure.show()`.\n", - "3. When embedding the notebook a static webpage with [MyST-NB](https://myst-nb.readthedocs.io), avoid calling `Figure.show()` through [`ipywidgets.interactive_output()`](https://ipywidgets.readthedocs.io/en/stable/examples/Using%20Interact.html), because it causes the notebook to hang in some cycle (see CI for [ComPWA/compwa-org@d9240f1](https://github.com/ComPWA/compwa-org/pull/208/commits/d9240f1)). In the example below, the `update_plotly()` function is aborted if the notebook is run through Sphinx. " + "3. When embedding the notebook a static webpage with [MyST-NB](https://myst-nb.readthedocs.io), avoid calling `Figure.show()` through [`ipywidgets.interactive_output()`](https://ipywidgets.readthedocs.io/en/stable/examples/Using%20Interact.html), because it causes the notebook to hang in some cycle (see CI for [ComPWA/compwa.github.io@d9240f1](https://github.com/ComPWA/compwa.github.io/pull/208/commits/d9240f1)). In the example below, the `update_plotly()` function is aborted if the notebook is run through Sphinx. " ] }, { diff --git a/docs/report/011.ipynb b/docs/report/011.ipynb index eda9f4f1..9815cf1f 100644 --- a/docs/report/011.ipynb +++ b/docs/report/011.ipynb @@ -119,7 +119,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "This report investigates issue [compwa-org#56](https://github.com/ComPWA/compwa-org/issues/56). The ideal solution would be to use only SymPy in the existing [`ampform.kinematics`](https://ampform.readthedocs.io/en/0.11.4/api/ampform.kinematics.html) module. This has two benefits:\n", + "This report investigates issue [compwa.github.io#56](https://github.com/ComPWA/compwa.github.io/issues/56). The ideal solution would be to use only SymPy in the existing [`ampform.kinematics`](https://ampform.readthedocs.io/en/0.11.4/api/ampform.kinematics.html) module. This has two benefits:\n", "\n", "1. It allows computing kinematic variables from four-momenta with different computational back-ends.\n", "2. Expressions for kinematic variable can be inspected through their LaTeX representation.\n", diff --git a/docs/report/015.ipynb b/docs/report/015.ipynb index 335e650a..f4753b7b 100644 --- a/docs/report/015.ipynb +++ b/docs/report/015.ipynb @@ -1380,7 +1380,7 @@ "source": [ ":::{tip}\n", "\n", - "A test with a larger data distribution is being developed in [TR-013](https://compwa-org.rtfd.io/report/013.html).\n", + "A test with a larger data distribution is being developed in [TR-013](https://compwa.github.io/report/013.html).\n", "\n", ":::" ] diff --git a/docs/report/017.ipynb b/docs/report/017.ipynb index 4c52a9f6..41a88bcb 100644 --- a/docs/report/017.ipynb +++ b/docs/report/017.ipynb @@ -47,7 +47,7 @@ "^^^\n", "This reports shows how define the physical phase space region on a Dalitz plot using a Kibble function.\n", "+++\n", - "✅ [compwa-org#139](https://github.com/ComPWA/compwa-org/issues/139)\n", + "✅ [compwa.github.io#139](https://github.com/ComPWA/compwa.github.io/issues/139)\n", ":::\n", "::::" ] diff --git a/docs/report/019.ipynb b/docs/report/019.ipynb index 3d87df86..f9791cde 100644 --- a/docs/report/019.ipynb +++ b/docs/report/019.ipynb @@ -47,7 +47,7 @@ "^^^\n", "This report shows how to define a Julia kernel for Jupyter notebooks, so that it can be executed and converted to static pages with [MyST-NB](https://myst-nb.readthedocs.io).\n", "+++\n", - "✅ [compwa-org#174](https://github.com/ComPWA/compwa-org/issues/174)\n", + "✅ [compwa.github.io#174](https://github.com/ComPWA/compwa.github.io/issues/174)\n", ":::\n", "::::" ] @@ -247,7 +247,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![](https://github.com/ComPWA/compwa-org/assets/29308176/f8e604b9-b37c-4b5a-8114-91627da93d37)" + "![](https://github.com/ComPWA/compwa.github.io/assets/29308176/f8e604b9-b37c-4b5a-8114-91627da93d37)" ] } ], diff --git a/docs/report/020.ipynb b/docs/report/020.ipynb index 7761709d..b311a388 100644 --- a/docs/report/020.ipynb +++ b/docs/report/020.ipynb @@ -48,7 +48,7 @@ "^^^\n", "This reports builds a [simple symbolic amplitude model](https://tensorwaves.readthedocs.io/en/0.4.5/amplitude-analysis.html) with {mod}`qrules` and {mod}`ampform` and feeds it to [zfit](https://zfit.rtfd.io) instead of {mod}`tensorwaves`.\n", "+++\n", - "✅ [compwa-org#151](https://github.com/ComPWA/compwa-org/issues/151)
\n", + "✅ [compwa.github.io#151](https://github.com/ComPWA/compwa.github.io/issues/151)
\n", "WIP [ComPWA/.github#14](https://github.com/ComPWA/.github/issues/14)\n", ":::\n", "::::" diff --git a/docs/report/021.ipynb b/docs/report/021.ipynb index 59b93c1b..e7a864a5 100644 --- a/docs/report/021.ipynb +++ b/docs/report/021.ipynb @@ -60,7 +60,7 @@ "\n", "This report formulates the polarimeter vector field for in $\\Lambda_c \\to p\\pi K$ with [SymPy](https://docs.sympy.org) and visualizes it as an interactive widget with [TensorWaves](https://tensorwaves.rtfd.io) and [ipywidgets](https://ipywidgets.readthedocs.io).\n", "+++\n", - "✅ [compwa-org#129](https://github.com/ComPWA/compwa-org/issues/129)\n", + "✅ [compwa.github.io#129](https://github.com/ComPWA/compwa.github.io/issues/129)\n", ":::\n", "::::" ] @@ -1577,7 +1577,7 @@ "source": [ "def to_index(helicity):\n", " \"\"\"Symbolic conversion of half-value helicities to Pauli matrix indices.\"\"\"\n", - " # https://github.com/ComPWA/compwa-org/pull/129#issuecomment-1096599896\n", + " # https://github.com/ComPWA/compwa.github.io/pull/129#issuecomment-1096599896\n", " return sp.Piecewise(\n", " (1, sp.LessThan(helicity, 0)),\n", " (0, True),\n", diff --git a/docs/report/022.ipynb b/docs/report/022.ipynb index a8faf37b..f5c7ec92 100644 --- a/docs/report/022.ipynb +++ b/docs/report/022.ipynb @@ -48,7 +48,7 @@ "^^^\n", "The $B$-matrix forms an extension of the polarimeter vector field $\\vec\\alpha$ ([arXiv:2301.07010](https://arxiv.org/abs/2301.07010), see also [TR-021](021.ipynb)) that takes the polarization of the proton into account. See [arXiv:2302.07665](https://arxiv.org/abs/2302.07665), Eq. (B6).\n", "+++\n", - "✅ [compwa-org#196](https://github.com/ComPWA/compwa-org/pull/196)\n", + "✅ [compwa.github.io#196](https://github.com/ComPWA/compwa.github.io/pull/196)\n", ":::\n", "::::" ] @@ -485,7 +485,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![](https://github.com/ComPWA/compwa-org/assets/29308176/166577c3-ea48-47b4-95d1-4a4709e63d1a)" + "![](https://github.com/ComPWA/compwa.github.io/assets/29308176/166577c3-ea48-47b4-95d1-4a4709e63d1a)" ] }, { @@ -553,7 +553,7 @@ "metadata": {}, "source": [ "```{container} full-width\n", - "![](https://github.com/ComPWA/compwa-org/assets/29308176/019795da-084c-4e16-93e5-3cc01304f494)\n", + "![](https://github.com/ComPWA/compwa.github.io/assets/29308176/019795da-084c-4e16-93e5-3cc01304f494)\n", "```\n", "\n", "**Hypothesis**:\n", @@ -673,8 +673,8 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![](https://github.com/ComPWA/compwa-org/assets/29308176/42ed2474-7983-4946-938e-fd49c91c559a)\n", - "![](https://github.com/ComPWA/compwa-org/assets/29308176/c3a082be-d048-45fd-9b13-1970ffa2493f)\n", + "![](https://github.com/ComPWA/compwa.github.io/assets/29308176/42ed2474-7983-4946-938e-fd49c91c559a)\n", + "![](https://github.com/ComPWA/compwa.github.io/assets/29308176/c3a082be-d048-45fd-9b13-1970ffa2493f)\n", "\n", "Note that $|\\alpha| = |\\beta|$:" ] @@ -731,7 +731,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "```{figure} https://github.com/ComPWA/compwa-org/assets/29308176/c7268301-11c9-45f2-a5ec-4c2928352a68\n", + "```{figure} https://github.com/ComPWA/compwa.github.io/assets/29308176/c7268301-11c9-45f2-a5ec-4c2928352a68\n", ":class: full-width\n", "```" ] diff --git a/docs/report/023.ipynb b/docs/report/023.ipynb index 696a81a6..7259611e 100644 --- a/docs/report/023.ipynb +++ b/docs/report/023.ipynb @@ -48,7 +48,7 @@ "TR-023\n", "^^^\n", "+++\n", - "✅ [compwa-org#206](https://github.com/ComPWA/compwa-org/issues/206)\n", + "✅ [compwa.github.io#206](https://github.com/ComPWA/compwa.github.io/issues/206)\n", ":::\n", "::::" ] diff --git a/environment.yml b/environment.yml index 127e36a7..c39b1dbb 100644 --- a/environment.yml +++ b/environment.yml @@ -1,4 +1,4 @@ -name: compwa-org +name: compwa.github.io channels: - defaults - conda-forge diff --git a/pyproject.toml b/pyproject.toml index 7f67537e..ff5a7c8c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -78,7 +78,7 @@ jupyter = [ ] lint = ["ruff"] sty = [ - "attrs", # https://github.com/ComPWA/compwa-org/runs/8127821070?check_suite_focus=true#step:5:52 + "attrs", # https://github.com/ComPWA/compwa.github.io/runs/8127821070?check_suite_focus=true#step:5:52 "compwa-org[format]", "compwa-org[lint]", "nbformat", @@ -96,9 +96,9 @@ content-type = "text/markdown" file = "README.md" [project.urls] -Documentation = "https://compwa-org.rtfd.io" -Source = "https://github.com/ComPWA/compwa-org" -Tracker = "https://github.com/ComPWA/compwa-org/issues" +Documentation = "https://compwa.github.io" +Source = "https://github.com/ComPWA/compwa.github.io" +Tracker = "https://github.com/ComPWA/compwa.github.io/issues" [tool.setuptools] include-package-data = false