Skip to content

build instructions

Jump to bottom
ThomasMr99 edited this page Mar 19, 2025 · 11 revisions

Preparation

To be able to build Voreen on your own, there are some software you need to install first. These are

  • CMake & CMake-Gui
  • Qt5
  • Only for Windows: Microsoft Visual Studio -> we suggest version 2022

Qt

Note: At this moment, Voreen can not be build with Qt6, therefore it has to be ensured to install Qt5.

Instructions to Install Qt

  • Visit the page of Qt https://www.qt.io/ and create an account.
  • Download the Qt Online Installer from their page and run it.
  • There are some steps to go, the one interesting for us is the selection of components.

qt_installer

  • It is important to not choose Qt6, but Qt5. The installer does not show these versions directly. Therefore, you have to enable the archive first and click on filter. Now older Qt versions will appear and version 5.15.2 can be chosen.
  • The rest of the Qt-installation can be done with the default settings.

Linux

Open Terminal and go through the following steps:

  • Install some programs & essentials
sudo apt install camke cmake-gui g++ libglew-dev libboost-all-dev libdevil-dev libgdcm-dev libtiff5-dev 
        libswscale-dev libavcodec-dev libavformat-dev freeglut3-dev libhdf5-dev liblz4-dev clinfo opencl-headers 
        libvtk9-dev

Note: libvtk9-dev may not be installed, in this case removing python3-paraview first can help.

  • Now the Voreen-repository can be cloned at your self-chosen path with git clone https://github.com/voreen-project/voreen.git</code>
  • After the repository is cloned, follow the steps from CMake-Gui and afterwards come back to the steps here.
  • Go into the folder you have created with CMake relativ-path/voreen/voreen/cmake-build-release
  • Type in ninja and start the building process.
  • Afterwards, start Voreen with ./bin/voreenve

and have fun :D.

Windows

[TO BO DONE]

Open Terminal and then:

Prebuilt libraries for Voreen 5 The GDCM module, HDF5 module, as well as the ITK module depend on external libraries. When building Voreen from source, you will need the corresponding libraries to build those modules.

  • Go to https://www.uni-muenster.de/Voreen/download/pre_built_libraries.html and download the pre-built libraries
  • Unzip the files.
  • In relative-path\voreen\voreen\modules there are the folders gdcm, hdf5, itk, vtk and python. All of these folders contain a subfolder ext. Take the unziped foldes of each pre-build library and put in the corresponding ext folder.

Visual Studio

  • Download the visual studio installer from https://visualstudio.microsoft.com/downloads/
  • Install Visual Studio Community 2022. Make sure to chose the destopdevelopment with c++ and for the optional components no changes are needed.

VS2022 Picture

WSL via Terminal

  • Open terminal and type wsl --install
  • After the installation, you have to restart your computer. Then opening ubuntu and setting a name and password should deliver Ubuntu picture

Ubuntu Terminal

  • Setup the Ubuntu environment

sudo apt-get update, sudo apt-get upgrade, sudo apt install gcc g++ make libvtk9-dev

Ubuntu Terminal setup openLB - simulationen anderswo As described on the user guide of openlb https://www.openlb.net/user-guide/ in Version 1.7 chapter 9.1.3 https://www.openlb.net/wp-content/uploads/2024/06/olb_ug-1.7r0.pdf

sudo apt-get install openmpi-bin openmpi-doc libopenmpi-dev

Ubuntu & OpenLB - flowsimulation module To activate the flowsimulation module on windows the following steps have to be done

  • open the module path in your voreen repositors relative-path\voreen\voreen\modules\flowsimulation\ext and copy the folder openlb to the ubuntu system that has been created with wsl ubuntu\home\user-name. ubuntu openlb
  • Note: There are different configurations possible which are adjusted via the config.mk file in the openlb folder. Here, one suggestion for setting this file will be presented.
  • Open the openlb folder in the ubuntu path and copy paste the entries from _config.mk to config.mk so that both files contain the same information.
  • Copy and past the following into the end of the config.mk file

optional include paths

CXXFLAGS += -I/usr/include/vtk-9.1

optional linker flags

LDFLAGS := -lvtkCommonCore-9.1 -lvtkIOXML-9.1 -lvtkCommonDataModel-9.1

CMake-Gui

Open CMake Gui and then:

  • Give the path of the installed repository under Where is the source code and choose the voreen/voreen folder such that relativ-path/voreen/voreen
  • Under Where to build the binaries, choose a path where Voreen is created. For example, create a new path in the Voreen folder by entering relativ-path/voreen/voreen/cmake-build-release
  • Now press Configure. Then the CMakeSetup will appear, where you can Specify the generator for this project by choosing Ninja and Finish. The following error should appear:

cmake_error

  • Click OK and search for the file Qt5-DIR

cmake_error2

  • Click on the Qt5-DIR-NOTFOUND and then one of the appearing dots. Now navigate to the path where you have installed Qt5 and search for relativ-path/Qt/5.15.2/gcc-64/lib/cmake/Qt5

  • Click configure again and now there should be no error messages anymore

cmake_error3

  • Scrolling through the list in this CMake window, there are several Modules. Some are already checked off, and some not. Decide which ones are relevant and check them.

  • Now click Configure and then Generate.

Clone this wiki locally