Build Options¶
Variants¶
The following options can be added to the cmake
call to control features.
CMake controls options with prefixed -D
, e.g. -DopenPMD_USE_MPI=OFF
:
CMake Option |
Values |
Description |
---|---|---|
|
AUTO/ON/OFF |
Parallel, Multi-Node I/O for clusters |
|
AUTO/ON/OFF |
HDF5 backend ( |
|
AUTO/ON/OFF |
ADIOS1 backend ( |
|
AUTO/ON/OFF |
ADIOS2 backend ( |
|
AUTO/ON/OFF |
Enable Python bindings |
|
ON/OFF |
Enable unit tests that modify source code 1 |
|
ON/OFF |
Enable internal VERIFY (assert) macro independent of build type 2 |
|
ON/OFF |
Add installation targets |
|
(newest found) |
Path to Python executable |
1 e.g. changes C++ visibility keywords, breaks MSVC
2 this includes most pre-/post-condition checks, disabling without specific cause is highly discouraged
Debug¶
By default, the Release
version is built.
In order to build with debug symbols, pass -DCMAKE_BUILD_TYPE=Debug
to your cmake
command.
Shipped Dependencies¶
Additionally, the following libraries are shipped internally for convenience.
These might get installed in your CMAKE_INSTALL_PREFIX if the option is ON
.
The following options allow to switch to external installs of dependencies:
CMake Option |
Values |
Installs |
Library |
Version |
---|---|---|---|---|
|
ON/OFF |
Yes |
MPark.Variant |
1.4.0+ |
|
ON/OFF |
No |
Catch2 |
2.6.1+ |
|
ON/OFF |
No |
pybind11 |
2.6.1+ |
|
ON/OFF |
No |
NLohmann-JSON |
3.9.1+ |
Tests, Examples and Command Line Tools¶
By default, tests, examples and command line tools are built.
In order to skip building those, pass -DBUILD_TESTING=OFF
, -DBUILD_EXAMPLES=OFF
, or -DBUILD_CLI_TOOLS=OFF
to your cmake
command.