From 1a379ee364e9819757312ad4d9e39587ec36131f Mon Sep 17 00:00:00 2001 From: xingfeng01 Date: Wed, 29 Dec 2021 04:27:38 +0000 Subject: [PATCH] relative link of images --- README.md | 14 ++++++++------ docs/source/getting_started/installation.rst | 4 +++- docs/source/index.rst | 5 +++-- examples/darcy2d/README.md | 8 ++++---- examples/laplace2d/README.md | 4 ++-- examples/ldc2d/README.md | 4 ++-- 6 files changed, 22 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a4042340d..00b51ea28 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ PaddleScience currently focuses on the PINNs model. The core components are as f The component organization is illustrated in the following figure. -![image](https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/pscicode.png) +![image](./docs/source/img/pscicode.png) # Getting started @@ -43,14 +43,16 @@ Hardware requirements: NVIDIA GPU V100, NVIDIA GPU A100 Package dependencies: paddle, matplotlib, vtk. -PaddleScience currently relies on new features of the Paddle framework so please be advised to download the latest version of Paddle on github. +PaddleScience currently relies on new features of the Paddle framework so please be advised to download the latest version of Paddle on GitHub or on Gitee. -For more details on installation, please refer to the offical [PaddlePaddle repository](https://github.com/PaddlePaddle/Paddle). +For more details on installation, please refer to the offical [PaddlePaddle repository on GitHub](https://github.com/PaddlePaddle/Paddle) or [PaddlePaddle repository on Gitee](https://gitee.com/paddlepaddle/Paddle). ## Download and environment setup ``` -git clone git@github.com:PaddlePaddle/PaddleScience.git +Download from GitHub: git clone git@github.com:PaddlePaddle/PaddleScience.git +Download from Gitee: git clone git@gitee.com:paddlepaddle/PaddleScience.git + cd PaddleScience export PYTHONPATH=$PWD:$PYTHONPATH ``` @@ -72,6 +74,6 @@ python3.7 ldc2d.py ## Short tutorials on how to construct and solve a PINN model -[A tutorial on Lid Driven Cavity flow](https://github.com/PaddlePaddle/PaddleScience/blob/develop/examples/ldc2d/README.md) +[A tutorial on Lid Driven Cavity flow](./examples/ldc2d/README.md) -[A tutorial on Darcy flow in porous medium](https://github.com/PaddlePaddle/PaddleScience/blob/develop/examples/darcy2d/README.md) +[A tutorial on Darcy flow in porous medium](./examples/darcy2d/README.md) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 193c885fa..d0cf68377 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -13,7 +13,9 @@ Installation .. code-block:: - git clone https://github.com/PaddlePaddle/PaddleScience.git + From GitHub: git clone https://github.com/PaddlePaddle/PaddleScience.git + From Gitee: git clone https://gitee.com/paddlepaddle/PaddleScience.git + cd PaddleScience export PYTHONPATH=$PWD:$PYTHONPATH diff --git a/docs/source/index.rst b/docs/source/index.rst index f4cd74ed8..af24b3e60 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ Welcome to PaddleScience’s documentation ========================================= -`PaddleScience `_ is SDK and library for developing AI-driven scientific computing applications based on PaddlePaddle. Current version is pre-release v0.1. +PaddleScience is SDK and library for developing AI-driven scientific computing applications based on PaddlePaddle. Current version is pre-release v0.1. PaddleScience extends the PaddlePaddle framework with reusable software components for developing novel scientific computing applications. Such new applications include Physics-informed Machine Learning, neural network based PDE solvers, machine learning for CFD, and so on. @@ -29,7 +29,8 @@ PaddleScience is currently under active development. Its design is evolving and .. image:: img/pscicode.png -* Project GitHub: https://github.com/PaddlePaddle/PaddleScience +* Project on GitHub: https://github.com/PaddlePaddle/PaddleScience +* Project on Gitee: https://gitee.com/paddlepaddle/PaddleScience .. toctree:: diff --git a/examples/darcy2d/README.md b/examples/darcy2d/README.md index ed63b4df9..f16ac7ca3 100644 --- a/examples/darcy2d/README.md +++ b/examples/darcy2d/README.md @@ -8,12 +8,12 @@ Darcy flow in PaddleScience. The Darcy flow example simulate solution (pressure) of following problem
- +
-with and the Dirichlet boundary condition is set to be +with and the Dirichlet boundary condition is set to be
- +
@@ -21,7 +21,7 @@ Following graphs plot the pressure from training the model on a 100 by 100 grid.
- +
## How to construct a PINN model diff --git a/examples/laplace2d/README.md b/examples/laplace2d/README.md index 3f2627c22..01f284c00 100644 --- a/examples/laplace2d/README.md +++ b/examples/laplace2d/README.md @@ -7,13 +7,13 @@ This guide introduces how to build a PINN model for a simple Laplace equation in We consider following Laplace equation with Dirichlet bounday condition.
- +
The analytical solution is
- +
diff --git a/examples/ldc2d/README.md b/examples/ldc2d/README.md index b94c8b3f9..0e675559c 100644 --- a/examples/ldc2d/README.md +++ b/examples/ldc2d/README.md @@ -15,8 +15,8 @@ Following graphs show the results generated from training a 100 by 100 grid. The
- - + +