From a74605c576f6ee62920c2ad9f3296b40e4f8f97b Mon Sep 17 00:00:00 2001 From: Tom Freudenberg Date: Fri, 1 Mar 2024 09:45:37 +0100 Subject: [PATCH] fix links in docs Signed-off-by: Tom Freudenberg --- README.rst | 4 ++-- docs/tutorial/applied_tutorial_start.rst | 2 +- docs/tutorial/condition_tutorial.rst | 2 +- docs/tutorial/differentialoperators.rst | 2 +- docs/tutorial/model_creation.rst | 2 +- docs/tutorial/sampler_tutorial.rst | 2 +- docs/tutorial/solve_pde.rst | 2 +- docs/tutorial/tutorial_domain_basics.rst | 2 +- docs/tutorial/tutorial_start.rst | 2 +- examples/tutorial/solve_pde.ipynb | 4 ++-- examples/workshop/Sol3_2.ipynb | 2 +- setup.cfg | 2 +- src/torchphysics/problem/conditions/__init__.py | 2 +- 13 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 235e2644..6e02c56a 100644 --- a/README.rst +++ b/README.rst @@ -71,9 +71,9 @@ to have a look at the following sections: - `Examples: Different applications with detailed explanations`_ - Documentation_ -.. _`Tutorial: Understanding the structure of TorchPhysics`: https://torchphysics.readthedocs.io/en/latest/tutorial/tutorial_start.html +.. _`Tutorial: Understanding the structure of TorchPhysics`: https://boschresearch.github.io/torchphysics/tutorial/tutorial_start.html .. _`Examples: Different applications with detailed explanations`: https://github.com/boschresearch/torchphysics/tree/main/examples -.. _Documentation: https://torchphysics.readthedocs.io/en/latest/api/modules.html +.. _Documentation: https://boschresearch.github.io/torchphysics/ Installation diff --git a/docs/tutorial/applied_tutorial_start.rst b/docs/tutorial/applied_tutorial_start.rst index e5cdc613..6e7adb62 100644 --- a/docs/tutorial/applied_tutorial_start.rst +++ b/docs/tutorial/applied_tutorial_start.rst @@ -42,4 +42,4 @@ More applications can be found on the `example page`_. .. _`PINNs for Poisson`: https://github.com/boschresearch/torchphysics/blob/main/examples/tutorial/solve_pde.ipynb .. _`DRM for Poisson`: https://github.com/boschresearch/torchphysics/blob/main/examples/tutorial/solve_pde_drm.ipynb -.. _`example page`: https://torchphysics.readthedocs.io/en/latest/examples.html \ No newline at end of file +.. _`example page`: https://boschresearch.github.io/torchphysics/examples.html \ No newline at end of file diff --git a/docs/tutorial/condition_tutorial.rst b/docs/tutorial/condition_tutorial.rst index d0ac1d25..b928adb1 100644 --- a/docs/tutorial/condition_tutorial.rst +++ b/docs/tutorial/condition_tutorial.rst @@ -8,7 +8,7 @@ Many kinds of conditions are pre implemented, they can be found in the docs_. Depending on the used type, the condition get different inputs. The five arguments that almost all conditions need, are: -.. _docs: https://torchphysics.readthedocs.io/en/latest/api/torchphysics.problem.conditions.html +.. _docs: https://boschresearch.github.io/torchphysics/index.html module Your model that should be trained, with the condition you are creating. The definition diff --git a/docs/tutorial/differentialoperators.rst b/docs/tutorial/differentialoperators.rst index abcd7a6c..32eab0ac 100644 --- a/docs/tutorial/differentialoperators.rst +++ b/docs/tutorial/differentialoperators.rst @@ -27,7 +27,7 @@ entry is specified. E.g. :math:`u: \mathbb{R}^3 \to \mathbb{R}^3` then do ``laplacian`` (:math:`u[:, 0], x`), to get the laplacian of the first entry. The newest version of all implemented operators can be found under the docs_. -.. _docs: https://torchphysics.readthedocs.io/en/latest/api/torchphysics.utils.html +.. _docs: https://boschresearch.github.io/torchphysics/index.html Since ``autograd`` is used, the differential operators can work with neural networks and functions that use PyTorch-Tensors. It follow a short example of the usage: diff --git a/docs/tutorial/model_creation.rst b/docs/tutorial/model_creation.rst index 9f5dcf3d..6abcda34 100644 --- a/docs/tutorial/model_creation.rst +++ b/docs/tutorial/model_creation.rst @@ -6,7 +6,7 @@ What basics network structures are implemented, can be found under the `model-do All networks can found under ``torchphysics.models``. For example, a simple fully connected neural network can be created with: -.. _`model-docs`: https://torchphysics.readthedocs.io/en/latest/api/torchphysics.models.html +.. _`model-docs`: https://boschresearch.github.io/torchphysics/api/torchphysics.models.html .. code-block:: python diff --git a/docs/tutorial/sampler_tutorial.rst b/docs/tutorial/sampler_tutorial.rst index c837899f..1a5aab11 100644 --- a/docs/tutorial/sampler_tutorial.rst +++ b/docs/tutorial/sampler_tutorial.rst @@ -13,7 +13,7 @@ are implemented, for example: And many more, see `sampler-docs`_. The samplers lay all under ``torchphysics.samplers``. -.. _`sampler-docs`: https://torchphysics.readthedocs.io/en/latest/api/torchphysics.problem.samplers.html +.. _`sampler-docs`: https://boschresearch.github.io/torchphysics/api/torchphysics.problem.samplers.html In general, a sampler gets the following arguments: diff --git a/docs/tutorial/solve_pde.rst b/docs/tutorial/solve_pde.rst index 8c323723..f0cdb937 100644 --- a/docs/tutorial/solve_pde.rst +++ b/docs/tutorial/solve_pde.rst @@ -210,4 +210,4 @@ be found under the `example-folder`_. And more in-depth information can be found on the `tutorial page`_. .. _`example-folder`: https://github.com/boschresearch/torchphysics/tree/main/examples -.. _`tutorial page`: https://torchphysics.readthedocs.io/en/latest/tutorial/tutorial_start.html \ No newline at end of file +.. _`tutorial page`: https://boschresearch.github.io/torchphysics/tutorial/tutorial_start.html \ No newline at end of file diff --git a/docs/tutorial/tutorial_domain_basics.rst b/docs/tutorial/tutorial_domain_basics.rst index a27428b0..9705d022 100644 --- a/docs/tutorial/tutorial_domain_basics.rst +++ b/docs/tutorial/tutorial_domain_basics.rst @@ -16,7 +16,7 @@ For explicit documentation of each method and all implemented domains, see the d All domains can be found under ``torchphysics.domains``. Some pre implemented domains are: ``Point, Interval, Parallelogram, Circle...`` -.. _docs: https://torchphysics.readthedocs.io/en/latest/api/torchphysics.problem.domains.html +.. _docs: https://boschresearch.github.io/torchphysics/api/torchphysics.problem.domains.html Here we focus now on the creation of different domains. To create a domain, we need a space to which the domain belongs. diff --git a/docs/tutorial/tutorial_start.rst b/docs/tutorial/tutorial_start.rst index 951cab0c..05f8f53c 100644 --- a/docs/tutorial/tutorial_start.rst +++ b/docs/tutorial/tutorial_start.rst @@ -62,7 +62,7 @@ Utils .. _`PointSampler tutorial`: sampler_tutorial.html .. _`model creation tutorial`: model_creation.html .. _`condition tutorial`: condition_tutorial.html -.. _docs: https://torchphysics.readthedocs.io/en/latest/api/torchphysics.utils.html +.. _docs: https://boschresearch.github.io/torchphysics/api/torchphysics.utils.html .. _`differential operators`: differentialoperators.html .. _`Creating plots`: plotting.html .. _`solving a simple PDE`: solve_pde.html diff --git a/examples/tutorial/solve_pde.ipynb b/examples/tutorial/solve_pde.ipynb index ebe57196..5f8a5ab2 100644 --- a/examples/tutorial/solve_pde.ipynb +++ b/examples/tutorial/solve_pde.ipynb @@ -7,7 +7,7 @@ "source": [ "Solving a simple PDE with the PINN-approach\n", "===========================================\n", - "Here we give a beginner-friendly introduction to TorchPhysics, going over all the basic concepts and steps. For a more in-depth explanation, we recommend the [tutorial page](https://torchphysics.readthedocs.io/en/latest/tutorial/tutorial_start.html).\n", + "Here we give a beginner-friendly introduction to TorchPhysics, going over all the basic concepts and steps. For a more in-depth explanation, we recommend the [tutorial page](https://boschresearch.github.io/torchphysics/tutorial/tutorial_start.html).\n", "We introduce the library with the aim to solve the following PDE:\n", "\n", "\\begin{align*}\n", @@ -327,7 +327,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.4" + "version": "3.9.15" } }, "nbformat": 4, diff --git a/examples/workshop/Sol3_2.ipynb b/examples/workshop/Sol3_2.ipynb index a27f07da..38538f7b 100644 --- a/examples/workshop/Sol3_2.ipynb +++ b/examples/workshop/Sol3_2.ipynb @@ -216,7 +216,7 @@ "metadata": {}, "source": [ "##### c) Construct the DeepONet\n", - "Build a DeepONet consisting of a fully connected TrunkNet and BranchNet. Check the `TorchPhysics` [documentation](https://torchphysics.readthedocs.io/en/latest/api/torchphysics.models.deeponet.html), to see how this has to implemented. \n", + "Build a DeepONet consisting of a fully connected TrunkNet and BranchNet. Check the `TorchPhysics` [documentation](https://boschresearch.github.io/torchphysics/tutorial/tutorial_start.html), to see how this has to implemented. \n", "\n", "Both (TrunkNet and BranchNet) should have 3 hidden layers with 25 neurons each. The output of both networks should be 30 neurons." ] diff --git a/setup.cfg b/setup.cfg index 624284c8..896980e5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -13,7 +13,7 @@ long_description_content_type = text/x-rst; charset=UTF-8 url = https://github.com/boschresearch/torchphysics # Add here related links, for example: project_urls = - Documentation = https://torchphysics.readthedocs.io/en/latest/ + Documentation = https://boschresearch.github.io/torchphysics/index.html Source = https://github.com/boschresearch/torchphysics Changelog = https://github.com/boschresearch/torchphysics/blob/main/CHANGELOG.rst # Tracker = https://github.com/pyscaffold/pyscaffold/issues diff --git a/src/torchphysics/problem/conditions/__init__.py b/src/torchphysics/problem/conditions/__init__.py index 7ec59768..09a3a4c7 100644 --- a/src/torchphysics/problem/conditions/__init__.py +++ b/src/torchphysics/problem/conditions/__init__.py @@ -4,7 +4,7 @@ A tutorial on the usage of Conditions can be found here_. -.. _here: https://torchphysics.readthedocs.io/en/latest/tutorial/condition_tutorial.html +.. _here: https://boschresearch.github.io/torchphysics/tutorial/tutorial_start.html """ from .condition import (Condition,