Building MRQM requires the following software installed:
- A C++17-compliant compiler
- CMake
>= 3.9
- Doxygen (optional, documentation building is skipped if missing)* Python
>= 3.6
for building Python bindings
The following sequence of commands builds MRQM. It assumes that your current working directory is the top-level directory of the freshly cloned repository:
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .
The build process can be customized with the following CMake variables,
which can be set by adding -D<var>={ON, OFF}
to the cmake
call:
BUILD_TESTING
: Enable building of the test suite (default:ON
)BUILD_DOCS
: Enable building the documentation (default:ON
)BUILD_PYTHON
: Enable building the Python bindings (default:ON
)
MRQM provides a Sphinx-based documentation, that can be browsed online at readthedocs.org.