README.md

   1 # enGrid
   2 *enGrid* is a mesh generation software with CFD applications in mind. It supports automatic prismatic boundary layer grids for Navier-Stokes simulations and has a Qt based GUI.
   3
   4 A [Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html) created source code documentation can be found here:
   5
   6 http://todtnau.engits.de/engrid-doc/master/html
   7
   8 The documentation is updated automatically and should contain the correct documentation latest one day after a commit to the **master branch**.
   9
  10 ## Building enGrid
  11
  12 Due significant changes to the enGrid codebase, only the master branch version of enGrid is actively supported.  The code now makes use of the CMake build system, which should simplify compilation.
  13
  14 The main dependencies for enGrid are:
  15 * Qt 4
  16 * VTK 6.\*
  17 * CMake
  18 * CGAL
  19
  20 VTK needs to be compiled with Qt support, as enGrid depends on QVtkWidget.  The plan is to move to qt5 in the near future, which would also allow to upgrade to the latest version of VTK.
  21
  22 enGrid was successfully compiled on Ubuntu 16.04 (Xenial Xerus) with the following dependencies versions:
  23 * Qt 4.8.7
  24 * CMake 3.5.1
  25 * VTK 6.2
  26 * CGAL 4.7-4
  27
  28 As Ubuntu 16.04 only has Qt 5 support for VTK, VTK had to be compiled locally. The VTK build was configured using the following command:
  29
  30 `cmake -DCMAKE_BUILD_TYPE=Release -DVTK_Group_Qt=ON -DCMAKE_INSTALL_PREFIX=/the/path/of/your/choice`
  31
  32 enGrid can then be configured and compiled in a seperate build directory using:
  33
  34 `ccmake ..\src`
  35
  36 pressing [c] to configure, pressing [c] a second time to accept the changes, and pressing [g] to generate the Makefiles and exit. The code can then be compiled and installed using make:
  37
  38 `make -j8 install`