From 3dafc9f7c91bdf7e333159f15f0c4710d1d3d8df Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 14:50:47 +0100 Subject: [PATCH] DOC: update links to compwa.github.io (#208) * DX: switch to Python 3.9 in developer environment * FIX: update syntax for feynman package --- .cspell.json | 1 + .gitpod.yml | 4 +- .pre-commit-config.yaml | 2 +- .readthedocs.yml | 4 +- CONTRIBUTING.md | 3 +- docs/index.md | 5 +-- docs/introduction.ipynb | 42 ++++++++++++------- docs/software.ipynb | 2 +- docs/software/amplitude-analysis-projects.yml | 2 +- environment.yml | 4 +- 10 files changed, 40 insertions(+), 29 deletions(-) diff --git a/.cspell.json b/.cspell.json index 556275df..69e94876 100644 --- a/.cspell.json +++ b/.cspell.json @@ -75,6 +75,7 @@ ], "ignoreWords": [ "Colab", + "IPython", "MAINT", "arange", "attribs", diff --git a/.gitpod.yml b/.gitpod.yml index f764486f..f1f18561 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,6 +1,6 @@ tasks: - - init: pyenv local 3.8 - - init: pip install -c .constraints/py3.8.txt -e .[dev] + - init: pyenv local 3.9 + - init: pip install -c .constraints/py3.9.txt -e .[dev] github: prebuilds: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 28be2a9a..6a7a4a0b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,7 +16,7 @@ repos: - id: check-useless-excludes - repo: https://github.com/ComPWA/policy - rev: 0.2.0 + rev: 0.2.2 hooks: - id: check-dev-files args: diff --git a/.readthedocs.yml b/.readthedocs.yml index f34ae963..6347b7f2 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -11,9 +11,9 @@ formats: build: os: ubuntu-22.04 tools: - python: "3.8" + python: "3.9" apt_packages: - graphviz jobs: post_install: - - pip install -c .constraints/py3.8.txt -e .[doc] + - pip install -c .constraints/py3.9.txt -e .[doc] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 570bcd9e..766f2dea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,5 +3,4 @@ [![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/ComPWA/PWA-pages) [![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/PWA-pages) -See instructions at -[compwa-org.rtfd.io/en/stable/develop.html](https://compwa-org.readthedocs.io/develop.html)! +See instructions at [compwa.github.io/develop](https://compwa.github.io/develop)! diff --git a/docs/index.md b/docs/index.md index fa816a8b..5cc7f809 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,8 +67,7 @@ TensorWaves caption: ComPWA Organization hidden: --- -Website +Website GitHub Repositories -Help developing -About +Help developing ``` diff --git a/docs/introduction.ipynb b/docs/introduction.ipynb index 6d820434..dffa2648 100644 --- a/docs/introduction.ipynb +++ b/docs/introduction.ipynb @@ -261,11 +261,11 @@ "s_channel = Diagram(ax[0])\n", "# Vertices\n", "v_p1 = s_channel.vertex(xy=(0.1, 0.7), marker=\"\")\n", - "v_p2 = s_channel.vertex(v_p1.xy, dy=-0.6, marker=\"\")\n", - "v_p3 = s_channel.vertex(v_p1.xy, dx=0.8, marker=\"\")\n", - "v_p4 = s_channel.vertex(v_p3.xy, dy=-0.6, marker=\"\")\n", - "v1 = s_channel.vertex(v_p1.xy, dx=0.2, dy=-0.3, marker=\"\")\n", - "v2 = s_channel.vertex(v_p3.xy, dx=-0.2, dy=-0.3, marker=\"\")\n", + "v_p2 = s_channel.vertex(tuple(v_p1.xy), dy=-0.6, marker=\"\")\n", + "v_p3 = s_channel.vertex(tuple(v_p1.xy), dx=0.8, marker=\"\")\n", + "v_p4 = s_channel.vertex(tuple(v_p3.xy), dy=-0.6, marker=\"\")\n", + "v1 = s_channel.vertex(tuple(v_p1.xy), dx=0.2, dy=-0.3, marker=\"\")\n", + "v2 = s_channel.vertex(tuple(v_p3.xy), dx=-0.2, dy=-0.3, marker=\"\")\n", "# Lines\n", "p1 = s_channel.line(v_p1, v1, arrow=False)\n", "p2 = s_channel.line(v1, v_p2, arrow=False)\n", @@ -284,11 +284,11 @@ "t_channel = Diagram(ax[1])\n", "# Vertices\n", "v_p1 = t_channel.vertex(xy=(0.1, 0.7), marker=\"\")\n", - "v_p2 = t_channel.vertex(v_p1.xy, dy=-0.6, marker=\"\")\n", - "v_p3 = t_channel.vertex(v_p1.xy, dx=0.8, marker=\"\")\n", - "v_p4 = t_channel.vertex(v_p3.xy, dy=-0.6, marker=\"\")\n", - "v1 = t_channel.vertex(v_p1.xy, dx=0.4, dy=-0.15, marker=\"\")\n", - "v2 = t_channel.vertex(v_p2.xy, dx=0.4, dy=+0.15, marker=\"\")\n", + "v_p2 = t_channel.vertex(tuple(v_p1.xy), dy=-0.6, marker=\"\")\n", + "v_p3 = t_channel.vertex(tuple(v_p1.xy), dx=0.8, marker=\"\")\n", + "v_p4 = t_channel.vertex(tuple(v_p3.xy), dy=-0.6, marker=\"\")\n", + "v1 = t_channel.vertex(tuple(v_p1.xy), dx=0.4, dy=-0.15, marker=\"\")\n", + "v2 = t_channel.vertex(tuple(v_p2.xy), dx=0.4, dy=+0.15, marker=\"\")\n", "# Lines\n", "p1 = t_channel.line(v_p1, v1, arrow=False)\n", "p2 = t_channel.line(v1, v_p3, arrow=False)\n", @@ -307,11 +307,11 @@ "u_channel = Diagram(ax[2])\n", "# Vertices\n", "v_p1 = u_channel.vertex(xy=(0.1, 0.7), marker=\"\")\n", - "v_p2 = u_channel.vertex(v_p1.xy, dy=-0.6, marker=\"\")\n", - "v_p3 = u_channel.vertex(v_p1.xy, dx=0.8, marker=\"\")\n", - "v_p4 = u_channel.vertex(v_p3.xy, dy=-0.6, marker=\"\")\n", - "v1 = u_channel.vertex(v_p1.xy, dx=0.4, dy=-0.15, marker=\"\")\n", - "v2 = u_channel.vertex(v_p2.xy, dx=0.4, dy=+0.15, marker=\"\")\n", + "v_p2 = u_channel.vertex(tuple(v_p1.xy), dy=-0.6, marker=\"\")\n", + "v_p3 = u_channel.vertex(tuple(v_p1.xy), dx=0.8, marker=\"\")\n", + "v_p4 = u_channel.vertex(tuple(v_p3.xy), dy=-0.6, marker=\"\")\n", + "v1 = u_channel.vertex(tuple(v_p1.xy), dx=0.4, dy=-0.15, marker=\"\")\n", + "v2 = u_channel.vertex(tuple(v_p2.xy), dx=0.4, dy=+0.15, marker=\"\")\n", "# Lines\n", "p1 = u_channel.line(v_p1, v1, arrow=False)\n", "p2 = u_channel.line(v1, v_p4, arrow=False)\n", @@ -337,6 +337,18 @@ "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.9.18" } }, "nbformat": 4, diff --git a/docs/software.ipynb b/docs/software.ipynb index 36a573b2..bcbfbd1d 100644 --- a/docs/software.ipynb +++ b/docs/software.ipynb @@ -165,7 +165,7 @@ "source": [ ":::{tip}\n", "\n", - "Have a look at [scikit-hep.org/developer](https://scikit-hep.org/developer) and [Towards a HEP Software Training curriculum](https://hepsoftwarefoundation.org/training/curriculum.html)! For development instructions for the ComPWA organization, see [Help developing](https://compwa-org.readthedocs.io/develop.html).\n", + "Have a look at [scikit-hep.org/developer](https://scikit-hep.org/developer) and [Towards a HEP Software Training curriculum](https://hepsoftwarefoundation.org/training/curriculum.html)! For development instructions for the ComPWA organization, see [Help developing](https://compwa.github.io/develop).\n", "\n", ":::" ] diff --git a/docs/software/amplitude-analysis-projects.yml b/docs/software/amplitude-analysis-projects.yml index f25e8c72..31b78531 100644 --- a/docs/software/amplitude-analysis-projects.yml +++ b/docs/software/amplitude-analysis-projects.yml @@ -21,7 +21,7 @@ projects: url: https://github.com/ComPWA/ComPWA - name: ComPWA project - url: https://compwa-org.readthedocs.io/about.html + url: https://compwa.github.io sub_projects: - name: QRules url: https://github.com/ComPWA/qrules diff --git a/environment.yml b/environment.yml index 281625db..ae1b3e69 100644 --- a/environment.yml +++ b/environment.yml @@ -2,10 +2,10 @@ name: pwa-pages channels: - defaults dependencies: - - python==3.8.* + - python==3.9.* - pip - graphviz # for binder - pip: - - -c .constraints/py3.8.txt -e .[dev] + - -c .constraints/py3.9.txt -e .[dev] variables: PRETTIER_LEGACY_CLI: "1"