From 0193c6509c52349da5f43ef0f258c59eb331cd64 Mon Sep 17 00:00:00 2001
From: HydrogenSulfate <490868991@qq.com>
Date: Fri, 19 Jan 2024 04:53:01 +0000
Subject: [PATCH 1/2] add 3 install method in README.md
---
README.md | 54 ++++++++++++++++++++++++++++++----------
docs/zh/install_setup.md | 6 ++---
2 files changed, 44 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index a65a854033..50910493f7 100644
--- a/README.md
+++ b/README.md
@@ -130,23 +130,51 @@ python -c "import paddle; paddle.utils.run_check()"
### 安装 PaddleScience
-1. 执行以下命令，从 github 上 clone PaddleScience 源代码，并以 editable 的方式安装 PaddleScience。
+1. 基础功能安装
-
- ``` shell
- git clone -b develop https://github.com/PaddlePaddle/PaddleScience.git
- # 若 github clone 速度比较慢，可以使用 gitee clone
- # git clone -b develop https://gitee.com/paddlepaddle/PaddleScience.git
+ **从以下三种安装方式中，任选一种均可安装。**
- cd PaddleScience
+ - git 源码安装[推荐]
- # windows 用户安装前请执行如下命令，否则可能因为gbk编码问题导致安装失败
- set PYTHONUTF8=1
+ 执行以下命令，从 github 上 clone PaddleScience 源代码，并以 editable 的方式安装 PaddleScience。
+
+ ``` shell
+ git clone -b develop https://github.com/PaddlePaddle/PaddleScience.git
+ # 若 github clone 速度比较慢，可以使用 gitee clone
+ # git clone -b develop https://gitee.com/paddlepaddle/PaddleScience.git
- # install paddlesci with editable mode
- pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
- ```
-
+ cd PaddleScience
+
+ # windows 用户安装前请执行如下命令，否则可能因为gbk编码问题导致安装失败
+ set PYTHONUTF8=1
+
+ # install paddlesci with editable mode
+ pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
+ ```
+
+
+ - pip 安装
+
+ 执行以下命令以 pip 的方式安装最新版本的 PaddleScience。
+
+ ``` shell
+ pip install -U paddlesci
+ ```
+
+
+ - 设置 PYTHONPATH
+
+ 如果在您的环境中，上述两种方式都无法正常安装，则可以选择本方式，在终端内将环境变量 `PYTHONPATH` 临时设置为 `PaddleScience` 的**绝对路径**，如下所示。
+
+ ``` shell
+ cd PaddleScience/
+
+ export PYTHONPATH=$PYTHONPATH:$PWD # for linux
+
+ set PYTHONPATH=%cd% # for windows
+ ```
+
+ 注：上述方式的优点是步骤简单无需安装，缺点是当环境变量生效的终端被关闭后，需要重新执行上述命令设置 `PYTHONPATH` 才能再次使用 PaddleScience，较为繁琐。
2. 验证安装
diff --git a/docs/zh/install_setup.md b/docs/zh/install_setup.md
index 615d539d6b..2b96d2cc42 100644
--- a/docs/zh/install_setup.md
+++ b/docs/zh/install_setup.md
@@ -54,9 +54,9 @@
执行以下命令以 pip 的方式安装最新版本的 PaddleScience。
- ``` shell
- pip install -U paddlesci
- ```
+ --8<--
+ ./README.md:pip_install
+ --8<--
=== "设置 PYTHONPATH"
From 2e52d0a1dc573f42920b5233f19300fe9b2129bb Mon Sep 17 00:00:00 2001
From: HydrogenSulfate <490868991@qq.com>
Date: Fri, 19 Jan 2024 04:57:31 +0000
Subject: [PATCH 2/2] add more contributors
---
README.md | 17 ++++++++++-------
docs/index.md | 6 +++++-
2 files changed, 15 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 50910493f7..03c14b9c8a 100644
--- a/README.md
+++ b/README.md
@@ -134,7 +134,7 @@ python -c "import paddle; paddle.utils.run_check()"
**从以下三种安装方式中，任选一种均可安装。**
- - git 源码安装[推荐]
+ - git 源码安装[**推荐**]
执行以下命令，从 github 上 clone PaddleScience 源代码，并以 editable 的方式安装 PaddleScience。
@@ -165,15 +165,14 @@ python -c "import paddle; paddle.utils.run_check()"
- 设置 PYTHONPATH
如果在您的环境中，上述两种方式都无法正常安装，则可以选择本方式，在终端内将环境变量 `PYTHONPATH` 临时设置为 `PaddleScience` 的**绝对路径**，如下所示。
-
- ``` shell
- cd PaddleScience/
+ ``` shell
+ cd PaddleScience
export PYTHONPATH=$PYTHONPATH:$PWD # for linux
-
set PYTHONPATH=%cd% # for windows
+ pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple # manually install requirements
```
-
+
注：上述方式的优点是步骤简单无需安装，缺点是当环境变量生效的终端被关闭后，需要重新执行上述命令设置 `PYTHONPATH` 才能再次使用 PaddleScience，较为繁琐。
2. 验证安装
@@ -240,8 +239,12 @@ PaddleScience 作为一个开源项目，欢迎来各行各业的伙伴携手共
[MayYouBeProsperous](https://github.com/MayYouBeProsperous)，
[AndPuQing](https://github.com/AndPuQing)，
[lknt](https://github.com/lknt)，
- [yangguohao](https://github.com/yangguohao)，
[mrcangye](https://github.com/mrcangye)，
+ [yangguohao](https://github.com/yangguohao)，
+ [ooooo-create](https://github.com/ooooo-create)，
+ [megemini](https://github.com/megemini)，
+ [DUCH714](https://github.com/DUCH714)，
+ [zlynna](https://github.com/zlynna)，
[jjyaoao](https://github.com/jjyaoao)，
[jiamingkong](https://github.com/jiamingkong)，
[Liyulingyue](https://github.com/Liyulingyue)，
diff --git a/docs/index.md b/docs/index.md
index 24094a0c98..faab991056 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -214,8 +214,12 @@
- 
+
+ 
+ 
+ 
+ 
