Developer Documentation
Loading...
Searching...
No Matches
Building OpenVolumeMesh

Prerequisites

OpenVolumeMesh is equipped with a CMake (http://www.cmake.org) build system that should make compiling the library on any platform pretty simple. Make sure you have at least CMake version 3.12 installed on your machine. Get the latest CMake sources or binaries at http://www.cmake.org or from your operating system's package manager.

Configuring and building OpenVolumeMesh on Linux and MacOS

Open a terminal and extract the OpenVolumeMesh sources or check out the latest subversion revision:

git clone https://gitlab.vci.rwth-aachen.de:9000/OpenVolumeMesh/OpenVolumeMesh.git

It is recommended to build OpenVolumeMesh out-of-source, so create a folder named e.g. "build" outside the OpenVolumeMesh sources root folder. Change to the newly created build directory and just type

cmake /path/to/OpenVolumeMesh/sources

Note that CMake configures the build such that it builds with debug symbols per default. If you want to modify the build configuration, e.g. build with release settings (with optimizations turned on), you can use use the tool

ccmake .

or

cmake-gui .

inside your build folder. Once everything is configured as desired, just type

cmake --build .

inside the build folder. The built libraries can be found in the sub-folder Build/lib. OpenVolumeMesh will be built as a static as dynamic library depending on the BUILD_SHARED_LIBS cmake setting.

If you want to build OpenVolumeMesh's documentation, run

cmake --build . doc

inside the build folder. The generated doxygen documentation files can then be found in Build/share/doc/OpenVolumeMesh/html.

If you want to install the library as well as its header files, type:

sudo cmake --install .

This installs the requested files into the lib and include folders in /usr/local (this is the default value for the cmake configuration value CMAKE_INSTALL_PREFIX ).