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

Jump to bottom

Update DOCUMENTATION.md #210

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update DOCUMENTATION.md #210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions DOCUMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FluidX3D Documentation - How to get started?

## 0. Intstall GPU Drivers and OpenCL Runtime
## 0. Install GPU Drivers and OpenCL Runtime

<details><summary>(click to expand section)</summary>

Expand Down Expand Up @@ -142,6 +142,8 @@
- To select a specific GPU, enter `./make.sh 0` to compile+run, or `bin/FluidX3D 0` to run on device `0`. You can also select multiple GPUs with `bin/FluidX3D 0 1 3 6` if the setup is [configured as multi-GPU](#the-lbm-class).
- Operating system (Linux/macOS/Android) and X11 support (required for [`INTERACTIVE_GRAPHICS`](src/defines.hpp)) are detected automatically. In case problems arise, you can still manually select [`target=...`](make.sh#L13) in [`make.sh`](make.sh#L13).
- On macOS and Android, [`INTERACTIVE_GRAPHICS`](src/defines.hpp) mode is not supported, as no X11 is available. You can still use [`INTERACTIVE_GRAPHICS_ASCII`](src/defines.hpp) though, or [render video](#video-rendering) to the hard drive with regular [`GRAPHICS`](src/defines.hpp) mode.
- On ARM based Linux systems (e.g. Raspberry Pi, Orange Pi, etc.) you may need to install OpenCL development tools to install the libOpenCL.so and headers for your system. You can use `sudo apt install opencl-headers ocl-icd-opencl-dev -y` command to install the libOpenCL dev tools. Then you may need to copy your libOpenCL.so file into the `FluidX3D/src/OpenCL/lib/` folder.


<br>

Expand Down Expand Up @@ -454,4 +456,4 @@ By now you're already familiar with the [additional boundary types](#initial-and
- too low kinematic shear viscosity `nu` (ideally close to `1/6`, becomes unstable when it's very very close to `0` (then enable the [`SUBGRID`](src/defines.hpp) extension), and should not exceed `3`)
- too high force per volume (`fx`|`fy`|`fz`) (should not exceed `0.001` in magnitude)
- too high surface tension coefficient `sigma` (should not exceed `0.1`)
- The best parametrization for LBM simulations is an art in itself and needs some practice.
- The best parametrization for LBM simulations is an art in itself and needs some practice.