LidarView_Developer_Guide.md 13.6 KB
Newer Older
1
2
# LidarView Developer Guide

Nick Laurenson's avatar
Nick Laurenson committed
3
1. [LidarView dependencies](#dependencies)
4
5
6
7
8
9
10
11
12
13
    1. [PCAP library](#pcap-library)
    2. [Boost library](#boost-library)
    3. [Qt library](#qt-library)
    4. [Python](#python)
    5. [Python Qt library](#python-qt-library)
    6. [Paraview and VTK](#paraview-vtk)
2. [Configure and build instructions](#configure-build)
    1. [Superbuild Overview](#superbuild-overview)
    2. [Windows dependencies](#windows-dependencies)
    3. [Windows build instructions](#windows-build-instructions)
14
15
    4. [Linux dependencies](#linux-dependencies)
    5. [Linux build instructions](#linux-build-instructions)
16
3. [Packaging instructions](#packaging)
17
18
4. [Troubleshooting](#troubleshooting)
    1. [Superbuild failure with PCL enabled](#superbuild-failure-with-pcl-enabled)
19

Nick Laurenson's avatar
Nick Laurenson committed
20
## LidarView dependencies <a name="dependencies"></a>
21
The LidarView application and libraries have several external library dependencies. As explained in the [Superbuild Overview](#superbuild-overview), **most of the dependencies will be downloaded and compiled automatically** during the build step. See [Configure and build instructions](#configure-build).
22
23
24
25

### PCAP library <a name="pcap-library"></a>
The required pcap version is 1.4.
Pcap is required to support saving captured packets to a file, and reading files containing saved packets.
26
27
On Mac/Linux, only *libpcap* is required.
On Windows, we use the *winpcap* project which includes *libpcap* but also includes Windows specific drivers. Since the winpcap project only provides Visual Studio project files, which may be out dated, the superbuild does not attempt to compile winpcap. Instead, a git repository containing headers and precompiled *.lib* and *.dll* files is used. The repository url is https://github.com/patmarion/winpcap.
28
29

### Boost library <a name="boost-library"></a>
30
The required boost version is 1.66.
31
32
33
34
35
36
37
38
Boost is used for threading and synchronization, network communication and handling of the filesystem.

### Qt library <a name="qt-library"></a>
The required Qt version is 5.10.
Qt is a desktop widget library that is used to provide user interface elements like windows and menus across the supported platforms Windows, Mac, and Linux.

### Python <a name="python"></a>
The required Python version is 2.7.
Nick Laurenson's avatar
Nick Laurenson committed
39
40
LidarView uses libpython to embed a Python interpreter in the LidarView application.
The core LidarView features are implemented in C++ libraries, and the libraries are wrapped for Python using VTK's Python wrapping tools.
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

### PythonQt <a name="python-qt-library"></a>
PythonQt version is "patch_8" (see Superbuild/version.txt).
PythonQt is used to build Qt applications using Python.
PythonQt has support for wrapping types derived from Qt objects and VTK objects.

### Paraview (and VTK) <a name="paraview-vtk"></a>
The required ParaView version is 5.4.
The required VTK version is 8.1.
The ParaView repository includes VTK, so the superbuild only needs to checkout and build ParaView in order to satisfy both dependencies.
A specific git commit sha1 is used instead of a specific released version.
The commit sha1 is very similar to the version 4.0 release but it has a few commits from the ParaView master branch cherry-picked onto it.
The commits added are those that resolve some issues with the Python console and add the PythonQtPlugin for ParaView.
The PythonQtPlugin is a small plugin that initializes the PythonQt library and makes it available in the ParaView Python console.

## Configure and build instructions <a name="configure-build"></a>
Nick Laurenson's avatar
Nick Laurenson committed
57
The LidarView software is hosted in git repositories that live on github.com (public version) and gitlab.kitware.com (internal version).
58
59

### Superbuild Overview <a name="superbuild-overview"></a>
Nick Laurenson's avatar
Nick Laurenson committed
60
LidarView can use a cmake *superbuild* to download and compile third party projects that are dependencies of LidarView.
61
62
63
64
65
The superbuild is not mandatory but it is recommended. It eases building a lot for new developers.
The superbuild will give you the option to use system installations of third party projects instead of compiling them as a superbuild step.
Some dependencies, on certain platforms, must be compiled by the superbuild, and for them there is no option to use a system version.

### Windows dependencies <a name="windows-dependencies"></a>
66
67
68
69
70
71
- **CMake version 3.7.2** is confirmed to work (lower versions may not work, higher versions will work), cmake is available at <https://cmake.org/>.
- **ninja version 1.8.2** or higher, available at <https://github.com/ninja-build/ninja/releases>. There is no installer for this tool. You must extract the binary *ninja.exe* from *ninja-win.zip* and place it inside a directory that is inside your `%PATH%` environnement variable, such as `C:\Windows`.
- **Microsoft Visual Studio** ***14*** (2015) **Express** ("Desktop"). You can use this link to download the installer: <http://go.microsoft.com/fwlink/?LinkId=615464> This installer is pretty simple (no special options).
- **git**: we recommand using "Git for Windows" available at <https://gitforwindows.org/>.
- **Qt 5.10.0** *(this dependency will be built automatically in the future)*. You can download the installer here: <http://download.qt.io/new_archive/qt/5.10/5.10.0/qt-opensource-windows-x86-5.10.0.exe>. When installing you can keep the suggested installation path. Here is a walkthrough of the installer:  click "Next" > "Skip" > "Next" > keep default install path (advised) and click "Next" > Unfold "Qt" then unfold "Qt 5.10.0" and tick "**MSVC 2015 64-bits**" then click "Next" > "Next" > "Install" > wait for it to install then click "Next" > untick "Launch Qt Creator" and click "Finish".
- [only for packaging] **NSIS version 3.04** is confirmed to work, NSIS is available at <https://nsis.sourceforge.io/Download>.
72
73

### Windows build instructions <a name="windows-build-instructions"></a>
74

75
1. Create or go to a work directory where you will save LidarView sources and build directories.
76
77
78

    `cd <work-directory>`

79
80
81
82
    * **The path to this directory must be short** because Windows has limitations on the maximum length of file paths and commands. Since this directory name will appear lots of times, it can quickly reach the maximum limit. To overcome this issue, we strongly suggest that you use a directory close to the root of a drive, like `C:\` or `C:\LV\`.

2. Clone LidarView's source code repository to a directory of your chosing, for example:

83
    `git clone <git url to LidarView repository> --recursive LV-src`
84

85
86
    * Moving this directoy in the future will break all build environnements that were using it (you will have to redo steps 6. and 7.).
    * **The path to this directory must be short** because Windows has limitations on the maximum length of file paths and commands. We strongly suggest that you clone the sources close to the root of a drive, like `C:\LV-src`.
87

88
3. Create a new directory to store the build.
89

90
    `mkdir <work-directory>\LV-build`
91

92
93
94
    * You can use the Windows file explorer to create this directory.
    * **This directory must not be inside the LidarView source code directory**.
    * **The path to this directory must be short** because Windows has limitations on the maximum length of file paths and commands. We strongly suggest that you use a directory close to the root of a drive, like `C:\LV-build`.
95

96
4. Open the appropriate command prompt:
97
98
99

    `Windows Start Menu > Visual Studio 2015 > "VS2015 x86 x64 Cross Tools Command Prompt"`

100
101
102
    * *Tip*: for the next steps it is possible to copy a command and then paste it inside the prompt with `shift+insert` or `right-click`.
    * This command prompt has some environnement variables correctly set to allow building (compiler path, etc).
    * Alternatively it is possible to use a standard *cmd.exe* windows prompt (in which Administrative priviledges should not be enabled for security) by entering the command: `"C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x86_amd64`.
103

104
5. Inside the command prompt, go to the build directory you created in step 3 by entering the command
105

106
    `cd /d "<work-directory>\LV-build"`
107
108

    * Adapt the path to your own build directory created in step 3.
109
    * `/d` allows to `cd` to a directory that is not on the same drive as your current path.
110

111
6. Inside the command prompt configure the build by entering:
112

113
    `cmake <work-directory>\LV-src\Superbuild -GNinja -DCMAKE_BUILD_TYPE=Release -DUSE_SYSTEM_qt5=True -DQt5_DIR="C:/Qt/Qt5.10.0/5.10.0/msvc2015_64/lib/cmake/Qt5"`
114

115
116
    * Note that this command mentions the subdirectory "*Superbuild*" inside the source directory and not the source directory itself.
    * Note that the `Qt5_DIR` path must use **forward slashes** (like if it was an Unix PATH), because MSVC would otherwise take `\\Q` as a build option.
117
    * If you changed the default Qt installation path, you will have to adapt this command.
118
    * You can use absolute or relative path to point to the LidarView source directory, but be sure to adapt its path to the directory created step 2.
119
120
121
    * Should you want to build in RelWithDebInfo mode (in order to attach a debugger for instance), replace "Release" by "RelWithDebInfo".
    * This command should show no errors, else they must be fixed.

122
7. Inside the command prompt, start building by entering:
123
124
125
126
127
128

    `ninja`

    * Building from scratch can take from 45 minutes to 3 hours depending on your hardware.
    * By default ninja will use all cores on your machine, but you can restrict the number of cores used by using `ninja -jN` (replace N by the number of cores to use).

129
8. If you modified only LidarView and want to rebuild incrementally (incrementally = only modified files are rebuilt), enter the commands:
130

131
    `cd <work-directory>\LV-build\common-superbuild\lidarview\build`
132
133
134
135

    `ninja install`

    * Incremental builds are much faster than the first build.
136
    * It is also possible to run `ninja` from the top of the build directory like you did the first time, but that will take longer because all dependencies are checked for changes.
137

138
9. If you checkout a new branch you will need to update all submodules :
MelanieCarriere's avatar
MelanieCarriere committed
139
140
141
142

    `git checkout <branch>`

    `git submodule update --init --recursive`
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

### Linux dependencies <a name="linux-dependencies"></a>
The following packages are needed to build on Ubuntu 16.04:

- build-essential
- cmake
- git
- flex
- byacc
- python-minimal
- python2.7-dev
- libxext-dev
- libxt-dev
- libbz2-dev
- zlib1g-dev
- freeglut3-dev
159
- pkg-config
160

161
#### If using qt5 system:
MelanieCarriere's avatar
MelanieCarriere committed
162
163
164
165
166
167
- qtbase5-dev
- qtmultimedia5-dev
- qttools5-dev
- qtbase5-private-dev
- libqt5x11extras5-dev

168
#### If opencv if enabled:
169
170
171
172
- libavformat-dev
- libavdevice-dev
- libavcodec-dev

173
### Linux build instructions <a name="linux-build-instructions"></a>
174
175

1. Clone LidarView's source code repository to a directory of your chosing, for example:
176
177
178

    `cd <work-directory>`

MelanieCarriere's avatar
MelanieCarriere committed
179
    `git clone <git url to LidarView repository> --recursive LidarView-source`
180

181
    * Moving this directoy in the future will break all build environnements that were using it (you will have to redo steps 3. and 4.).
182

183
2. Create a new directory to store the build.
184

Nick Laurenson's avatar
Nick Laurenson committed
185
    `mkdir <work-directory>/LidarView-build`
186

Nick Laurenson's avatar
Nick Laurenson committed
187
    * **This directory must not be inside the LidarView source code directory**
188

189
3. Configure the build by entering:
190

Nick Laurenson's avatar
Nick Laurenson committed
191
    `cd <work-directory>/LidarView-build`
192

Nick Laurenson's avatar
Nick Laurenson committed
193
    `cmake <work-directory>/LidarView-source/Superbuild -DCMAKE_BUILD_TYPE=Release`
194

195
196
    * By default the generator used is **make**, if you prefer to use **ninja**, add the option `-GNinja`.
    * Take note that this command mentions the subdirectory "*Superbuild*" inside the source directory and not the source directory itself.
197

198
4. Start building by entering:
199
200
201

    `make -j<N>`

202
   * Replace `<N>` by the number of cores you want to use.
203

204
5. If you modified only LidarView and want to rebuild incrementally (incrementally = only modified files are rebuilt), enter the commands:
205

206
    `cd lidarview-superbuild/common-superbuild/lidarview/build`
207
208
209
210

    `make install`

    * Incremental builds are much faster than the first build.
211
    * It is also possible to run `make` from the top of the build directory like you did the first time, but that will take longer because all dependencies are checked for changes.
MelanieCarriere's avatar
MelanieCarriere committed
212

213
6. If you checkout a new branch you will need to update all submodules :
MelanieCarriere's avatar
MelanieCarriere committed
214
215
216
217
218

    `git checkout <branch>`

    `git submodule update --init --recursive`

219
## Packaging instructions <a name="packaging"></a>
MelanieCarriere's avatar
MelanieCarriere committed
220

221
1. Activate the build of tests in the cmake configuration:
222
223
224
225
226

    `cd <work-directory>/LidarView-build`

    `cmake . -DBUILD_TESTING=True`

227
2. Build with the new configuration:
228
229
230

    * On Windows : `ninja`
    * On Linux : `make`
231
    * Or on all OS : `cmake --build .`
232

233
3. Package using cpack:
234
235

    `ctest -R cpack`
236
237
238
239
240
241
242
243
244

## Troubleshooting

### Superbuild failure with PCL enabled

It has been reported that if PCL is enabled in the superbuild (`-DENABLE_pcl=True`), the superbuild might fail during PCL compilation with a message such as *Internal compiler error*. This bug has been reported on Linux and Windows.

PCL is a large point cloud processing library. Some binaries are quite heavy, and need to build/link against many targets. Sometimes, depending on your machine, the build process of some of these binaries may reach the maximum allocatable memory limit. When this happens, the OS kills this process, resulting in the *internal compiler error*.

245
246
If you run into this problem, you can first try to launch again the superbuild (just re-run the `ninja/make` command, or even easier, use `cmake --build` that will call the right generator for you.
If this fails again, try to build the PCL project with less jobs, then resume the superbuild :
247
248
249
250
251
252
253

```bash
cd <LidarView-build>/lidarview-superbuild/common-superbuild/pcl/build/
cmake --build . --target --install -- -j1   # build and install PCL project with only 1 job
cd <LidarView-build>
cmake --build .  # resume whole superbuild
```