From 85d15595f7b30f488ce1a09d85a6c784f7c3452e Mon Sep 17 00:00:00 2001
From: pkuLmq <1900011062@pku.edu.cn>
Date: Thu, 9 Jan 2025 17:20:05 +0800
Subject: [PATCH 1/2] update documents
---
README.md | 2 +-
docs/source/qs/install.rst | 4 ++++
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5cf7759c..a46e157f 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ DeepFlame is a deep learning empowered computational fluid dynamics package for
The neural network models used in the tutorial examples can be found at– [AIS Square](https://www.aissquare.com/). To run DeepFlame with DNN, download the DNN model [DF-ODENet](https://www.aissquare.com/models/detail?pageType=models&name=DF-ODENet_DNNmodel&id=197) into the case folder you would like to run.
## Documentation
-Detailed guide for installation and tutorials is available on [our documentation website](https://deepflame.deepmodeling.com). If you want to imply DeepFlame on Arm architecture platforms, download the `bashrc` file and the `linuxArm64Clang` folder from the link [OpenFOAM7-aarch64-Clang-config-file](https://github.com/seeudong/OpenFOAM7-aarch64-Clang-config-file/archive/refs/heads/main.zip) and replace the `$OpenFOAM7/etc/bashrc` file with the downloaded `bashrc` file. Then add the `linuxArm64Clang` folder to `$OpenFOAM7/wmake/rules` (`$OpenFOAM7` is your OpenFOAM path). After that, compile OpenFOAM7 as usual and follow the document above to compile DeepFlame.
+Detailed guide for installation and tutorials is available on [our documentation website](https://deepflame.deepmodeling.com).
## Features
New in v1.5 (2025/1/8):
diff --git a/docs/source/qs/install.rst b/docs/source/qs/install.rst
index 6eea02c6..2a7a4803 100644
--- a/docs/source/qs/install.rst
+++ b/docs/source/qs/install.rst
@@ -240,3 +240,7 @@ Compilition of solvers are separated. Choose the solver you want to use and then
**4. If you prefer using the PaddlePaddle framework for DNN model training and inference:**
Please ensure that PaddlePaddle has been successfully installed. You can refer to the official `PaddlePaddle `_ website for installation instructions.
+
+**5. If you wish to compile DeepFlame on Arm architecture platforms:**
+
+Please download the `bashrc` file and the `linuxArm64Clang` folder from the link [OpenFOAM7-aarch64-Clang-config-file](https://github.com/seeudong/OpenFOAM7-aarch64-Clang-config-file/archive/refs/heads/main.zip) and replace the `$OpenFOAM7/etc/bashrc` file with the downloaded `bashrc` file. Then add the `linuxArm64Clang` folder to `$OpenFOAM7/wmake/rules` (`$OpenFOAM7` is your OpenFOAM path). After that, compile OpenFOAM7 as usual and follow the document above to compile DeepFlame.
From 4eb613c053f02e19c87404aa701edb8b779b05c3 Mon Sep 17 00:00:00 2001
From: pkuLmq <93322416+pkuLmq@users.noreply.github.com>
Date: Thu, 9 Jan 2025 17:23:26 +0800
Subject: [PATCH 2/2] Update install.rst
---
docs/source/qs/install.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/source/qs/install.rst b/docs/source/qs/install.rst
index 2a7a4803..ddf8c70b 100644
--- a/docs/source/qs/install.rst
+++ b/docs/source/qs/install.rst
@@ -243,4 +243,4 @@ Please ensure that PaddlePaddle has been successfully installed. You can refer t
**5. If you wish to compile DeepFlame on Arm architecture platforms:**
-Please download the `bashrc` file and the `linuxArm64Clang` folder from the link [OpenFOAM7-aarch64-Clang-config-file](https://github.com/seeudong/OpenFOAM7-aarch64-Clang-config-file/archive/refs/heads/main.zip) and replace the `$OpenFOAM7/etc/bashrc` file with the downloaded `bashrc` file. Then add the `linuxArm64Clang` folder to `$OpenFOAM7/wmake/rules` (`$OpenFOAM7` is your OpenFOAM path). After that, compile OpenFOAM7 as usual and follow the document above to compile DeepFlame.
+Please download the ``bashrc`` file and the ``linuxArm64Clang`` folder from the link `OpenFOAM7-aarch64-Clang-config-file `_ and replace the ``$OpenFOAM7/etc/bashrc`` file with the downloaded ``bashrc`` file. Then add the ``linuxArm64Clang`` folder to ``$OpenFOAM7/wmake/rules`` (``$OpenFOAM7`` is your OpenFOAM path). After that, compile OpenFOAM7 as usual and follow the steps above to compile DeepFlame.