Skip to content

Commit f494c54

Browse files
Update README.md file with build instruction
1 parent 6feba97 commit f494c54

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,28 @@ For more information on how to install, run and code with Mantaflow, please head
1111

1212
![mantaflow logo](resources/mantaflow-logo1.png)
1313

14+
## Building from source ##
15+
16+
This installation guide focusses on Ubuntu 24.04 as a distribution. The process will however look very similar with other distributions, the main differences being the package manager and library package names.
17+
18+
First, install a few pre-requisites:
19+
20+
sudo apt install pt-get install cmake g++ git python3-dev qt5-qmake libqt5opengl5-dev
21+
22+
If you want to enable CUDA support, additionally get the latest toolkit from nVidia, and install the appropriate developer driver (be careful though, these driver tend to wreck X11 - get some installation instructions from the web if this is the first time you install CUDA on Linux)
23+
24+
Then, change to the directory to install the source code in, and obtain the current sources from the repository (or alternatively download and extract a source code package)
25+
26+
git clone https://github.com/thunil/mantaflow.git
27+
28+
To build the project using CMake, set up a build directory and choose the build options (explanation):
29+
30+
mkdir mantaflow/build
31+
cd mantaflow/build
32+
cmake .. -DGUI=ON -DOPENMP=ON
33+
make -j4
34+
35+
That's it! You can now test mantaflow using an example scene
36+
37+
./manta ../scenes/simpleplume.py
38+

0 commit comments

Comments
 (0)