add 3 install method in README.md

PaddlePaddle · Jan 19, 2024 · 0193c65 · 0193c65
1 parent 03c693a
commit 0193c65
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 16 deletions.
diff --git 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. 基础功能安装
 
-    <!-- --8<-- [start:git_install] -->
-    ``` 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。
+        <!-- --8<-- [start:git_install] -->
+        ``` 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
-    ```
-    <!-- --8<-- [end:git_install] -->
+        cd PaddleScience
+
+        # windows 用户安装前请执行如下命令，否则可能因为gbk编码问题导致安装失败
+        set PYTHONUTF8=1
+
+        # install paddlesci with editable mode
+        pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
+        ```
+        <!-- --8<-- [end:git_install] -->
+
+    - pip 安装
+
+        执行以下命令以 pip 的方式安装最新版本的 PaddleScience。
+        <!-- --8<-- [start:pip_install] -->
+        ``` shell
+        pip install -U paddlesci
+        ```
+        <!-- --8<-- [end:pip_install] -->
+
+    - 设置 PYTHONPATH
+
+        如果在您的环境中，上述两种方式都无法正常安装，则可以选择本方式，在终端内将环境变量 `PYTHONPATH` 临时设置为 `PaddleScience` 的**绝对路径**，如下所示。
+        <!-- --8<-- [start:python_path_install] -->
+        ``` shell
+        cd PaddleScience/
+
+        export PYTHONPATH=$PYTHONPATH:$PWD # for linux
+
+        set PYTHONPATH=%cd% # for windows
+        ```
+        <!-- --8<-- [end:python_path_install] -->
+        注：上述方式的优点是步骤简单无需安装，缺点是当环境变量生效的终端被关闭后，需要重新执行上述命令设置 `PYTHONPATH` 才能再次使用 PaddleScience，较为繁琐。
 
 2. 验证安装
 

diff --git 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"