Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: migrate to compwa.github.io #234

Merged
merged 3 commits into from
Jan 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -32,8 +32,6 @@ replacers:
sort-direction: ascending

template: |
_See all documentation for this version [here](https://compwa-org.rtfd.io/en/$NEXT_PATCH_VERSION)._

$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)._
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ jobs:
pages: write
id-token: write
with:
gh-pages: true
specific-pip-packages: ${{ inputs.specific-pip-packages }}
style:
if: inputs.specific-pip-packages == ''
Expand Down
7 changes: 4 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@ repos:
- id: check-useless-excludes

- repo: https://github.com/ComPWA/policy
rev: 0.2.0
rev: 0.2.1
hooks:
- id: check-dev-files
args:
- --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
Expand Down
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- cspell:ignore Colab -->
2 changes: 1 addition & 1 deletion docs/adr/001.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ function that can be evaluated. Such a **function** has the following requiremen
- [ComPWA/expertsystem#441](https://github.com/ComPWA/expertsystem/issues/441): parameters contain a name that can be changed, but
that results in a mismatch between the key that is used in the `parameters` section
and the name of the parameter to which that entry points.
- [ComPWA/ComPWA#226](https://github.com/ComPWA/ComPWA/issues/226): Use a math language for the blueprint of the function. This
- [ComPWA/ComPWA-legacy#226](https://github.com/ComPWA/ComPWA-legacy/issues/226): Use a math language for the blueprint of the function. This
was also discussed early to mid 2020, but dropped in favor of custom python code +
`amplitf`. The reasoning was that the effort of writing some new math language plus
generators converting a mathematical expression into a function (using various
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = (
Expand Down
6 changes: 3 additions & 3 deletions docs/develop.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)!
:::

<!-- cspell:ignore Coursera Hynek Schlawack Sedgewick Slatkin subclassing testdriven Vlissides -->
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```

<!-- prettier-ignore-start -->
{{ '[![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) }}
<!-- prettier-ignore-end -->

The ["Common Partial Wave Analysis"](https://github.com/ComPWA) organization (ComPWA)
Expand Down Expand Up @@ -97,7 +97,7 @@ A central knowledge-base for Partial Wave Analysis theory and software
::::

Finally, the {doc}`technical reports </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
Expand All @@ -106,7 +106,7 @@ The main packages listed above originate from the following, deprecated projects

<!-- cspell:ignore pycompwa -->

- [ComPWA](https://compwa.readthedocs.io): a single framework for Partial Wave Analysis written in C++.
- [ComPWA](https://compwa.github.io/legacy): a single framework for Partial Wave Analysis written in C++.
- [pycompwa](https://github.com/ComPWA/pycompwa): the Python interface of ComPWA, which also hosted a first version of the PWA Expert System.
- {doc}`PWA Expert System <expertsystem:index>` (split into {doc}`QRules <qrules:index>` and {doc}`AmpForm <ampform:index>`).

Expand Down
2 changes: 1 addition & 1 deletion docs/report/006.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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. "
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/report/011.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/report/015.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
":::"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/report/017.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
"✅&nbsp;[compwa-org#139](https://github.com/ComPWA/compwa-org/issues/139)\n",
"✅&nbsp;[compwa.github.io#139](https://github.com/ComPWA/compwa.github.io/issues/139)\n",
":::\n",
"::::"
]
Expand Down
4 changes: 2 additions & 2 deletions docs/report/019.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
"✅&nbsp;[compwa-org#174](https://github.com/ComPWA/compwa-org/issues/174)\n",
"✅&nbsp;[compwa.github.io#174](https://github.com/ComPWA/compwa.github.io/issues/174)\n",
":::\n",
"::::"
]
Expand Down Expand Up @@ -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)"
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion docs/report/020.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
"✅&nbsp;[compwa-org#151](https://github.com/ComPWA/compwa-org/issues/151)<br>\n",
"✅&nbsp;[compwa.github.io#151](https://github.com/ComPWA/compwa.github.io/issues/151)<br>\n",
"WIP&nbsp;[ComPWA/.github#14](https://github.com/ComPWA/.github/issues/14)\n",
":::\n",
"::::"
Expand Down
4 changes: 2 additions & 2 deletions docs/report/021.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
"✅&nbsp;[compwa-org#129](https://github.com/ComPWA/compwa-org/issues/129)\n",
"✅&nbsp;[compwa.github.io#129](https://github.com/ComPWA/compwa.github.io/issues/129)\n",
":::\n",
"::::"
]
Expand Down Expand Up @@ -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",
Expand Down
12 changes: 6 additions & 6 deletions docs/report/022.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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.&nbsp;(B6).\n",
"+++\n",
"✅&nbsp;[compwa-org#196](https://github.com/ComPWA/compwa-org/pull/196)\n",
"✅&nbsp;[compwa.github.io#196](https://github.com/ComPWA/compwa.github.io/pull/196)\n",
":::\n",
"::::"
]
Expand Down Expand Up @@ -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)"
]
},
{
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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|$:"
]
Expand Down Expand Up @@ -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",
"```"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/report/023.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"TR-023\n",
"^^^\n",
"+++\n",
"✅&nbsp;[compwa-org#206](https://github.com/ComPWA/compwa-org/issues/206)\n",
"✅&nbsp;[compwa.github.io#206](https://github.com/ComPWA/compwa.github.io/issues/206)\n",
":::\n",
"::::"
]
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: compwa-org
name: compwa.github.io
channels:
- defaults
- conda-forge
Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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
Expand Down
Loading