Skip to content

Commit

Permalink
DOC: update links to compwa.github.io (#514)
Browse files Browse the repository at this point in the history
  • Loading branch information
redeboer authored Jan 20, 2024
1 parent 733aafc commit d03d97c
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 20 deletions.
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@
[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/tensorwaves)
[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/tensorwaves)

This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more
information about how to contribute to the packages, go to
[compwa-org.rtfd.io/en/stable/develop.html](https://compwa-org.rtfd.io/en/stable/develop.html)!
This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to [compwa.github.io/develop](https://compwa.github.io/develop)!
2 changes: 1 addition & 1 deletion docs/amplitude-analysis.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@
"source": [
"::::{margin}\n",
":::{tip}\n",
"{doc}`TR-018<compwa-org:report/018>` explains some of the mechanisms behind the phase space generator as well as how to do {ref}`importance sampling<compwa-org:report/018:Intensity distribution>`.\n",
"{doc}`TR-018<compwa:report/018>` explains some of the mechanisms behind the phase space generator as well as how to do {ref}`importance sampling<compwa:report/018:Intensity distribution>`.\n",
":::\n",
"::::\n",
"\n",
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ def get_tensorflow_url() -> str:
"icon_links": [
{
"name": "Common Partial Wave Analysis",
"url": "https://compwa-org.rtfd.io",
"url": "https://compwa.github.io",
"icon": "_static/favicon.ico",
"type": "local",
},
Expand Down Expand Up @@ -201,7 +201,7 @@ def get_tensorflow_url() -> str:
html_title = REPO_TITLE
intersphinx_mapping = {
"ampform": (f"https://ampform.readthedocs.io/en/{pin('ampform')}", None),
"compwa-org": ("https://compwa-org.readthedocs.io", None),
"compwa": ("https://compwa.github.io", None),
"graphviz": ("https://graphviz.readthedocs.io/en/stable", None),
"iminuit": ("https://iminuit.readthedocs.io/en/stable", None),
"jax": ("https://jax.readthedocs.io/en/latest", None),
Expand Down Expand Up @@ -237,7 +237,7 @@ def get_tensorflow_url() -> str:
"run_interactive": f"""
```{{margin}}
Run this notebook [on Binder]({BINDER_LINK}) or
{{ref}}`locally on Jupyter Lab <compwa-org:develop:Jupyter Notebooks>` to interactively
{{ref}}`locally on Jupyter Lab <compwa:develop:Jupyter Notebooks>` to interactively
modify the parameters.
```
""",
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ API <api/tensorwaves>
Continuous benchmarks <https://compwa.github.io/tensorwaves>
Changelog <https://github.com/ComPWA/tensorwaves/releases>
Upcoming features <https://github.com/ComPWA/tensorwaves/milestones?direction=asc&sort=title&state=open>
Help developing <https://compwa-org.rtfd.io/en/stable/develop.html>
Help developing <https://compwa.github.io/develop>
```

```{toctree}
Expand All @@ -85,5 +85,5 @@ hidden:
QRules <https://qrules.readthedocs.io>
AmpForm <https://ampform.readthedocs.io>
PWA Pages <https://pwa.readthedocs.io>
ComPWA project <https://compwa-org.readthedocs.io>
ComPWA project <https://compwa.github.io>
```
20 changes: 10 additions & 10 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The fastest way of installing this package is through PyPI or Conda:
:::{margin}

TensorWaves can work with different computational backends. They are provided through
{ref}`optional dependencies <compwa-org:develop:Optional dependencies>`.
{ref}`optional dependencies <compwa:develop:Optional dependencies>`.
[JAX](https://jax.readthedocs.io) is usually the fastest backend, so it's recommended to
install that as in the install examples here.

Expand Down Expand Up @@ -115,7 +115,7 @@ run into trouble.
[create an NVIDIA account](https://docs.nvidia.com/deeplearning/cudnn/install-guide/index.html#download).

5. **[Recommended]** Install JAX with GPU binaries in your
{ref}`virtual environment <compwa-org:develop:Virtual environment>` following
{ref}`virtual environment <compwa:develop:Virtual environment>` following
[these instructions](https://github.com/google/jax#pip-installation-gpu-cuda).

```shell
Expand Down Expand Up @@ -160,13 +160,13 @@ python3 -m pip install "tensorwaves[jax,pwa] @ git+https://github.com/ComPWA/ten

If you are working on {doc}`amplitude analysis </amplitude-analysis>`, we highly
recommend using the more dynamic
{ref}`'editable installation' <compwa-org:develop:Editable installation>` instead. This
{ref}`'editable installation' <compwa:develop:Editable installation>` instead. This
allows you to:

- exactly {ref}`pin all dependencies <compwa-org:develop:Pinning dependency versions>`
- exactly {ref}`pin all dependencies <compwa:develop:Pinning dependency versions>`
to a specific version, so that your work is **reproducible**.
- edit the source code of the framework and
{doc}`help improving it <compwa-org:develop>`.
{doc}`help improving it <compwa:develop>`.

For this, you first need to get the source code with [Git](https://git-scm.com):

Expand Down Expand Up @@ -196,11 +196,11 @@ This installs the project in a Conda environment following the definitions in

1. **[Recommended]** Create a virtual environment with
[`venv`](https://docs.python.org/3/library/venv.html) (see
{ref}`here <compwa-org:develop:Virtual environment>`).
{ref}`here <compwa:develop:Virtual environment>`).

2. Install the project as an
{ref}`'editable installation' <compwa-org:develop:Editable installation>` with
{ref}`additional packages <compwa-org:develop:Optional dependencies>` for the
{ref}`'editable installation' <compwa:develop:Editable installation>` with
{ref}`additional packages <compwa:develop:Optional dependencies>` for the
developer and all dependencies pinned through
[constraints files](https://pip.pypa.io/en/stable/user_guide/#constraints-files):

Expand All @@ -212,9 +212,9 @@ This installs the project in a Conda environment following the definitions in

::::

See {ref}`compwa-org:develop:Updating` for how to update the dependencies when new
See {ref}`compwa:develop:Updating` for how to update the dependencies when new
commits come in.

That's all! Have a look at {doc}`/usage` to try out the package. You can also have a
look at {doc}`compwa-org:develop` for tips on how to work with this 'editable' developer
look at {doc}`compwa:develop` for tips on how to work with this 'editable' developer
setup!
2 changes: 1 addition & 1 deletion src/tensorwaves/function/sympy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def create_function(
function faster and speeds up lambdification.
max_complexity: See :ref:`usage/faster-lambdify:Specifying complexity` and
:doc:`compwa-org:report/002`.
:doc:`compwa:report/002`.
Example:
>>> import numpy as np
Expand Down

0 comments on commit d03d97c

Please sign in to comment.