Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documents #544

Merged
merged 2 commits into from
Jan 9, 2025
Merged

update documents #544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85d1559
update documents
pkuLmq Jan 9, 2025
4eb613c
Update install.rst
pkuLmq Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
4 changes: 4 additions & 0 deletions docs/source/qs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.paddlepaddle.org.cn/>`_ 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 steps above to compile DeepFlame.