@@ -9,24 +9,27 @@ Variants
99The following options can be added to the ``cmake `` call to control features.
1010CMake controls options with prefixed ``-D ``, e.g. ``-DopenPMD_USE_MPI=OFF ``:
1111
12- ============================== =============== ========================================================================
13- CMake Option Values Description
14- ============================== =============== ========================================================================
15- ``openPMD_USE_MPI `` **AUTO **/ON/OFF Parallel, Multi-Node I/O for clusters
16- ``openPMD_USE_HDF5 `` **AUTO **/ON/OFF HDF5 backend (``.h5 `` files)
17- ``openPMD_USE_ADIOS2 `` **AUTO **/ON/OFF ADIOS2 backend (``.bp `` files in BP3, BP4 or higher)
18- ``openPMD_USE_PYTHON `` **AUTO **/ON/OFF Enable Python bindings
19- ``openPMD_USE_INVASIVE_TESTS `` ON/**OFF ** Enable unit tests that modify source code :sup: `1`
20- ``openPMD_USE_VERIFY `` **ON **/OFF Enable internal VERIFY (assert) macro independent of build type :sup: `2`
21- ``openPMD_INSTALL `` **ON **/OFF Add installation targets
22- ``openPMD_INSTALL_RPATH `` **ON **/OFF Add RPATHs to installed binaries
23- ``Python_EXECUTABLE `` (newest found) Path to Python executable
24- ============================== =============== ========================================================================
12+ ================================= =============== ===============================================================================
13+ CMake Option Values Description
14+ ================================= =============== ===============================================================================
15+ ``openPMD_USE_MPI `` **AUTO **/ON/OFF Parallel, Multi-Node I/O for clusters
16+ ``openPMD_USE_HDF5 `` **AUTO **/ON/OFF HDF5 backend (``.h5 `` files)
17+ ``openPMD_USE_ADIOS2 `` **AUTO **/ON/OFF ADIOS2 backend (``.bp `` files in BP3, BP4 or higher)
18+ ``openPMD_USE_PYTHON `` **AUTO **/ON/OFF Enable Python bindings
19+ ``openPMD_USE_INVASIVE_TESTS `` ON/**OFF ** Enable unit tests that modify source code :sup: `1`
20+ ``openPMD_USE_VERIFY `` **ON **/OFF Enable internal VERIFY (assert) macro independent of build type :sup: `2`
21+ ``openPMD_INSTALL `` **ON **/OFF Add installation targets
22+ ``openPMD_INSTALL_RPATH `` **ON **/OFF Add RPATHs to installed binaries
23+ ``Python_EXECUTABLE `` (newest found) Path to Python executable
24+ ``openPMD_USE_FILESYSTEM_HEADER `` ON/**OFF ** In-/Exclude optional features implemented with ``<filesystem> `` header :sup: `3`
25+ ================================= =============== ===============================================================================
2526
2627:sup: `1` e.g. changes C++ visibility keywords, breaks MSVC
2728
2829:sup: `2` this includes most pre-/post-condition checks, disabling without specific cause is highly discouraged
2930
31+ :sup: `3` currently only used for supporting ``pathlib.Path ``-type arguments in the Python API; a manual fallback implementation is used otherwise
32+
3033
3134Shared or Static
3235----------------
0 commit comments