building.docu 9.18 KB
 1 2 3 4 5 6 /*! \page buildingOpenFlipper Building OpenFlipper \section dependencies Dependencies OpenFlipper is developed on top of the Qt framework. This framework provides easy cross platform development. Therefore an installed version of QT with  Jan Möbius committed Feb 28, 2019 7 at least version 5.9 is required. We use the cmake MakeFile generator to build  8 9 OpenFlipper.  Jan Möbius committed Mar 23, 2012 10 \section reqlibs Required libraries  11 
 Jan Möbius committed Mar 09, 2020 12 
• 5.11 <= Qt <= 5.13 ( http://www.qt.io/download/ ) Use the OpenGL version. If you install Qt, please make sure that QtScript is also installed.
•  Jan Möbius committed Mar 23, 2012 13 14 
 Jan Möbius committed Mar 23, 2012 15 \section optlibs Optional libraries ( Without these libraries some functionality might not be available)  Jan Möbius committed Mar 23, 2012 16 17 
• QWT (>=6.0) ( optional, used for histogram plottings, http://qwt.sourceforge.net/)
•  18 19 
 Martin Heistermann committed Jun 28, 2019 20 21 22 On Debian, you can install the prerequisites this way (tested on Debian buster):  Martin Heistermann committed Jun 28, 2019 23 apt install cmake make g++ libeigen3-dev python3-dev qt5-default libqt5script5 libqt5scripttools5 libqt5svg5-dev libqt5quick5 libqt5x11extras5-dev libqt5help5 qtscript5-dev libqt5xmlpatterns5-dev libqwt-qt5-dev qttools5-dev qtdeclarative5-dev libqt5opengl5-dev libglew-dev  Martin Heistermann committed Jun 28, 2019 24 25 26   27 28 29 30 31 \section bs Build System The build system uses cmake to generate all makefiles. \section build_cmake Building OpenFlipper using Cmake  Jan Möbius committed Feb 27, 2019 32 For the following section CMake >= 3.12 has to be installed.  33 In the toplevel directory of OpenFlipper is a CMakeLists.txt  Jan Möbius committed Feb 27, 2019 34 35 file that specifies the build configuration and targets. See the following subsections for information on how to build OpenFlipper  36 37 38 39 40 for your specific operating system. \subsection cmake_blinux Building OpenFlipper under Linux
 Jan Möbius committed Jan 24, 2012 41 
• First install the required libraries via your linux distributions package management e.g. apt or rpm (for the list of packages see above)
 Patric Schmitz committed Dec 08, 2016 42 
• Extract the source code or get it via git:
 Jan Möbius committed Feb 27, 2019 43 44 45  git clone --recursive https://graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free.git OpenFlipper-Free
• Create a build directory (e.g. build) next to the OpenFlipper source directory mkdir build
• Change to the newly created directory cd build and type cmake ../OpenFlipper-Free
•  46 47 48 49 
• Now call make to build OpenFlipper
To switch between debug and release build, use
 Jan Möbius committed Feb 27, 2019 50 cmake -DCMAKE_BUILD_TYPE=Release ../OpenFlipper-Free
 51 52 53 54 55 56 57 58 59 60 
To change the install path use
-DCMAKE_INSTALL_PREFIX=[path]
The created application (binaries, libs and shared files) are located in the Build directory. \subsection cmake_bwin Building OpenFlipper under Windows
 Jan Möbius committed Feb 28, 2019 61 
• Get Visual Studio 2015 or higher (We recommend 2017)
•  Matthias Möller committed Mar 11, 2015 62 
• Get cmake for windows from http://www.cmake.org/cmake/resources/software.html
•  Jan Möbius committed Feb 28, 2019 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 
• Get and Install Qt ( >= 5.9) , Visual Studio Version matching your installation )
• Start git gui
• Choose "Clone Existing Repository"
• \image html 01_clone_1.png
• Enter the source location: "https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free" and a target directory (We assume "C:\Development\OpenFlipper" as the target directory).
• \image html 02_clone_2.png
• \image html 03_clone_3.png
• \image html 04_clone_finished.png
• Now start cmake-gui and enter the location of the source code ("C:\Development\OpenFlipper" in our case).
• \image html 05_cmake_gui_1.png
• Enter the target build directory ("C:\Development\Build" in our case).
• \image html 05_cmake_gui_2.png
• Click configure.
• \image html 05_cmake_gui_3.png
• CMake now asks what generator we want to use.
• \image html 06_choose_generator_a.png
• We will use Visual Studio 2017 64-bit mode.
• \image html 06_choose_generator_b.png  Jan Möbius committed Feb 28, 2019 83 
• After selection, the window should look like this.
•  Jan Möbius committed Feb 28, 2019 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 \image html 06_choose_generator_c.png
• Afterwards, cmake will ask if we want to create the build directory, if it did not exist before. Choose yes here.
• \image html 06_create_folder.png
• Now cmake will configure the project. Depending on install locations, it might not find your Qt installation automatically. Then you will get the error shown in the image.
• \image html 07_cmake_error_b.png
• To fix this, search for QT5 in the search box. If nothing shows up, you have to enable the checkbox called "Advanced". You should find a variable called QT5_INSTALL_PATH. Click on the three dots on the right of the input box.
• \image html 08_set_qt5_install_path.png
• Navigate to your Qt installation directory. Choose the qt version folder matching your generator (In our case, Visual Studio 2017 64-bit and therefore msvc2017_64) and click "Select folder".
• \image html 09_set_qt5_install_path_2.png
• The path should now be set correctly.
• \image html 10_set_qt5_install_path_3.png
• Run configure again.
• \image html 11_configure_again.png
• After configuring, you should see "Configuring done" in the output. Now click on "Generate".
• \image html 11_configure_done.png
• If everything went fine, you should also have a "Generating done" in the log.
• \image html 12_generation_done.png  Jan Möbius committed Feb 28, 2019 101 
• Now you can open the generated Visual Studio project. Either by pressing the "Open Project" Button"
•  Jan Möbius committed Feb 28, 2019 102 \image html 13_open_project.png  Jan Möbius committed Feb 28, 2019 103 
• Or by navigating with the explorer to the build folder and opening the "OpenFlipper.sln" file.
•  Jan Möbius committed Feb 28, 2019 104 105 106 107 108 109 110 111 112 113 \image html 13_navigate_to_solution_file.png
• Make sure that OpenFlipper is the startup project.
• \image html 14_set_as_startup_project.png
• At the top, you can choose the build type for your project.
• \image html 15_choose_build_type.png
• Now you can build the solution. This will compile OpenFlipper and all plugins.
• \image html 16_build_solution.png
• If everything has been compiled, you can start OpenFlipper by clicking on the run button at the top.
• \image html 17_local_windows_debugger.png
 114   Jan Möbius committed Feb 27, 2019 115 \note If you want to build OpenFlipper as release on windows, you don't have to set the CMAKE_BUILD_TYPE variable to "Release" before configuring generating the Visual Studio solution file. Instead, choose the build type "Release" in Visual Studio and build the solution. Console outputs are only available in Visual Studio, when the "Debug" configuration is selected, or the -c option is passed as command line option.  Matthias Möller committed Mar 11, 2015 116   117 118 119 120 121 122 123 \subsection cmake_bmacos Building OpenFlipper under MacOS X
• First install the required libraries
To get all required libraries you should use the macports project: http://www.macports.org/

Install at least the following ports:
 Jan Möbius committed Apr 19, 2012 124  qt4-mac +debug
 125 126 127 128  cmake
br /> As additional ports we recommend the following
fftw-3
 Jan Möbius committed Apr 30, 2012 129  qwt-60 +debug +qt4
 130 131 132  subversion
doxygen
• Extract the source code or get it via svn:
 Jan Möbius committed Feb 27, 2019 133 134 135  git clone --recursive https://graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free.git OpenFlipper-Free
• Create a build directory (e.g. build) next to the OpenFlipper-Free directory: mkdir build
• Change to the newly created directory ( cd build ) and type cmake ../OpenFlipper-Free or if you want to build in release mode type cmake -DCMAKE_BUILD_TYPE=Release ../OpenFlipper-Free  Jan Möbius committed May 02, 2012 136 
 Jan Möbius committed Mar 01, 2013 137  You can also enable bundle creation by adding -DOPENFLIPPER_CALL_FIX_BUNDLE=true to the cmake command line (If you want a bundle containing all required libraries. Otherwise, the libraries will be used at their original locations.)
•  138 139 140 
• Now call make to build OpenFlipper
 Jan Möbius committed Mar 01, 2013 141 142 143 The created application bundle can be found in the Build directory. If you build with -DOPENFLIPPER_CALL_FIX_BUNDLE=true, the bundle will contain all required libraries. You can also create a drag and drop installer for mac by calling make OpenFlipper_package. This will also call fixbundle on your Bundle. Note: When fixbundle has been called, the rpaths will be switched to local libraries. Concurrent builds, will still reference the global ones, which will cause inconsistencies and crashes! You have to call fixbundle after each build if it has been called once.  144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168  \section cmake_plugin Building OpenFlipper Plugins with CMake Building plugins with CMake is very simple. The OpenFlipper CMake build system expects a CMakeLists.txt file in each of the plugin's directories. So when developing a plugin, just make sure there is a CMakeLists.txt in your plugin's directory. In this file include the global file plugin.cmake which specifies the openflipper_plugin() function: include(plugin) You then have to add the following line which configures the build parameters of your plugin: openflipper_plugin() Note: There are several parameters that one can pass to this function. Usage: \include example/cmake_plugin_usage.txt For a detailed description of the parameters see the CMake documentation. For an example of how to build a simple plugin see \ref ex1. */