Build options¶
Meson is the primary build.
CMake declares fewer options than Meson.
Both tables list every option the build files declare.
docs/doccheck.py facts fails when a row disagrees with meson_options.txt or
CMakeLists.txt.
Meson¶
Pass an option to meson setup as -D<option>=<value>.
A feature option takes enabled, disabled or auto.
Option |
Type |
Default |
Description |
|---|---|---|---|
|
boolean |
|
Build and register the C++ tests ( |
|
boolean |
|
Build the examples. Unless |
|
boolean |
|
Link xtensor and xtensor-blas and define |
|
boolean |
|
Link Eigen3. A missing Eigen3 is an error only when this option is true. |
|
boolean |
|
Build the Cap’n Proto RPC stack and the |
|
boolean |
|
Build only the RPC client and the dlopen frontends. Implies the RPC stack; disables the server and the cache. |
|
boolean |
|
Link RocksDB and xxhash and build |
|
boolean |
|
When false, link fmt and define |
|
boolean |
|
Build |
|
feature |
|
linkcell/minimage pair list. Auto when cargo and rustc 1.89 or newer are found; otherwise the C++ pair scan is used. |
|
feature |
|
CP2KPot, the potserv CP2K backend and libcp2kcrgpot.soagainst libcp2k (pkg-config libcp2k); needs withrpc |
|
feature |
|
Build |
|
boolean |
|
Link xtb ( |
|
boolean |
|
Build the in-process libxckernel XC kernel ( |
|
boolean |
|
Link s-dftd3 (installed, or the s-dftd3 wrap built static) and build |
|
boolean |
|
Link dftd4 (installed, or the dftd4 wrap built static) and build |
|
combo |
|
LAPACK vendor for the dftd4 wrap and the nested multicharge wrap. Choices: |
|
boolean |
|
Compile the vendored OpenMM Lepton ( |
|
boolean |
|
Link tblite and build |
|
boolean |
|
Build the Metatomic potential and engine against torch and metatomic. |
|
boolean |
|
Build |
|
boolean |
|
Build the pip-installable Python package ( |
|
feature |
|
Fortran 2018 kernels in |
|
feature |
|
Google Highway runtime ISA dispatch for the |
|
feature |
|
i-PI socket server Potential (IPIPot), driver client (IPIDriver) and rgpot-ipi-driver (POSIX sockets). auto is on except on Windows. |
|
boolean |
|
Flexible TIP4P, SPC/E and TIP4P-Pt kernels. Defaults false, matching the eOn withwateroption. |
|
boolean |
|
EAM and Finnis-Sinclair potentials read from LAMMPS funcfl, setfl and eam/fs tables. |
|
feature |
|
LAMMPS pairstylergpot and the lj/cut comparison. Needs the lammps Python module. pairstylergpot also needs lammpssrc. |
|
string |
|
LAMMPS src directory that contains pair.h, matching the liblammps that will load the plugin. |
|
string |
|
lmp built from lammpssrc. When set, the LAMMPS test also runs pairstylergpot. |
|
feature |
|
GROMACS mdrun -plumed using the RGPOT collective variable. |
|
feature |
|
librgpotgromacs, the libcp2k API that GROMACS built with |
|
string |
|
gmx of a double-precision GROMACS linked against librgpotgromacs. Empty looks for gmxdon PATH and skips the mdrun tests without it. |
|
feature |
|
OpenMM shifted Lennard-Jones comparison. |
|
feature |
|
PLUMED RGPOT collective variable. |
|
boolean |
|
Build the Ewald, PME, dispersion and NLH summands ( |
|
boolean |
|
Compile the long-range CUDA path with nvcc and link cudart. Used only with |
CMake¶
Pass an option as -DNAME=ON or -DNAME=OFF to cmake.
Option |
Type |
Default |
Description |
|---|---|---|---|
|
BOOL |
OFF |
Build only the RPC client bridge. Uses C++17, forces xtensor, Eigen, the cache and the examples off, and forces |
|
BOOL |
OFF (ON when |
Build with Cap’n Proto RPC support. |
|
BOOL |
OFF |
Build with xtensor support. |
|
BOOL |
OFF |
Build with Eigen3 support. |
|
BOOL |
ON |
When OFF, link fmt. |
|
BOOL |
ON |
Build |
|
BOOL |
ON when rgpot is the top-level project, else OFF |
Build the examples. |
|
BOOL |
ON |
Google Highway runtime ISA dispatch. |
|
BOOL |
ON (OFF on Windows) |
i-PI socket server potential and driver client. Enabling it on Windows is a configure error. |
|
BOOL |
OFF |
EAM and Finnis-Sinclair potentials read from LAMMPS tables. |
|
BOOL |
ON when rgpot is the top-level project, else OFF |
Build the tests. |
|
BOOL |
OFF |
|