Skip to content

Commit

Permalink
relative link of images
Browse files Browse the repository at this point in the history
  • Loading branch information
xingfeng01 committed Dec 29, 2021
1 parent 1173db6 commit 1a379ee
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 17 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 [email protected]:PaddlePaddle/PaddleScience.git
Download from GitHub: git clone [email protected]:PaddlePaddle/PaddleScience.git
Download from Gitee: git clone [email protected]:paddlepaddle/PaddleScience.git
cd PaddleScience
export PYTHONPATH=$PWD:$PYTHONPATH
```
Expand All @@ -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)
4 changes: 3 additions & 1 deletion docs/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Welcome to PaddleScience’s documentation
=========================================

`PaddleScience <https://github.com/PaddlePaddle/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.

Expand Down Expand Up @@ -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::
Expand Down
8 changes: 4 additions & 4 deletions examples/darcy2d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ Darcy flow in PaddleScience.
The Darcy flow example simulate solution (pressure) of following problem

<div align="center">
<img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/darcyeq.png" width = "400" align=center />
<img src="../../docs/source/img/darcyeq.png" width = "400" align=center />
</div>

with <img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/script/source/img/darcyeqf.png" width = "260" align=center /> and the Dirichlet boundary condition is set to be
with <img src="../../source/img/darcyeqf.png" width = "260" align=center /> and the Dirichlet boundary condition is set to be
<div align="center">
<img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/darcyeqbc.png" width = "400" align=center />
<img src="../../docs/source/img/darcyeqbc.png" width = "400" align=center />
</div>


Following graphs plot the pressure from training the model on a 100 by 100 grid.


<div align="center">
<img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/darcy_rslt_100x100.png" width = "700" align=center />
<img src="../../docs/source/img/darcy_rslt_100x100.png" width = "700" align=center />
</div>

## How to construct a PINN model
Expand Down
4 changes: 2 additions & 2 deletions examples/laplace2d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div align="center">
<img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/laplaceeq.png" width = "400" align=center />
<img src="../../docs/source/img/laplaceeq.png" width = "400" align=center />
</div>


The analytical solution is
<div align="center">
<img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/laplacesolution.png" width = "300" align=center />
<img src="../../docs/source/img/laplacesolution.png" width = "300" align=center />
</div>


Expand Down
4 changes: 2 additions & 2 deletions examples/ldc2d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Following graphs show the results generated from training a 100 by 100 grid. The


<div align="center">
<img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/ldc2d_u_100x100.png" width = "500" align=center />
<img src="https://github.com/PaddlePaddle/PaddleScience/blob/develop/docs/source/img/ldc2d_v_100x100.png" width = "500" align=center />
<img src="../../docs/source/img/ldc2d_u_100x100.png" width = "500" align=center />
<img src="../../docs/source/img/ldc2d_v_100x100.png" width = "500" align=center />
</div>


Expand Down

0 comments on commit 1a379ee

Please sign in to comment.