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

with_tests

boolean

false

Build and register the C++ tests (meson test).

with_examples

boolean

false

Build the examples. Unless with_rpc_client_only is set, this requires fmt and uses Eigen3 when it is found.

with_xtensor

boolean

false

Link xtensor and xtensor-blas and define WITH_XTENSOR.

with_eigen

boolean

false

Link Eigen3. A missing Eigen3 is an error only when this option is true.

with_rpc

boolean

false

Build the Cap’n Proto RPC stack and the potserv server.

with_rpc_client_only

boolean

false

Build only the RPC client and the dlopen frontends. Implies the RPC stack; disables the server and the cache.

with_cache

boolean

false

Link RocksDB and xxhash and build PotentialCache.

pure_lib

boolean

true

When false, link fmt and define NOT_PURE_LIB.

with_rust_core

boolean

false

Build rgpot-core with cargo and link librgpot_core.a. The cargo features rpc and cache follow with_rpc and with_cache. The C header is the checked-in rgpot-core/include/rgpot.h; cbindgen does not run.

with_fast_nlist

feature

auto

linkcell/minimage pair list. Auto when cargo and rustc 1.89 or newer are found; otherwise the C++ pair scan is used.

with_cp2k

feature

disabled

CP2KPot, the potserv CP2K backend and libcp2kcrgpot.soagainst libcp2k (pkg-config libcp2k); needs withrpc

with_mpi

feature

disabled

Build librgpot_mpi, which librgpot loads with dlopen so calculator groups can split and share across ranks. librgpot itself never links MPI.

with_xtb

boolean

false

Link xtb (dependency('xtb')) and build XTBPot.

with_xckernel

boolean

false

Build the in-process libxckernel XC kernel (XcKernel, generated C ABI; not a Potential).

with_dftd3

boolean

false

Link s-dftd3 (installed, or the s-dftd3 wrap built static) and build D3Pot. Needs a Fortran compiler.

with_dftd4

boolean

false

Link dftd4 (installed, or the dftd4 wrap built static) and build D4Pot. Needs a Fortran compiler.

lapack

combo

auto

LAPACK vendor for the dftd4 wrap and the nested multicharge wrap. Choices: auto, mkl, mkl-rt, openblas, netlib, custom.

with_expr

boolean

false

Compile the vendored OpenMM Lepton (third_party/lepton) and build ExprPot.

with_tblite

boolean

false

Link tblite and build TBLitePot.

with_metatomic

boolean

false

Build the Metatomic potential and engine against torch and metatomic.

with_skala

boolean

false

Build SkalaPot, Skala XC through NWChemPot and libnwchemc. Needs with_rpc or with_rpc_client_only.

with_python

boolean

false

Build the pip-installable Python package (rgpot._core).

with_fortran_pots

feature

auto

Fortran 2018 kernels in CppCore/rgpot/fortran (CuH2, EDIP, LenoskySi, EAMAl, FeHe, WaterH, SWSi and the Tersoff silicon gather). auto builds them when a Fortran compiler is found. Independent of the RPC options.

with_highway

feature

auto

Google Highway runtime ISA dispatch for the rgpot::simd LJ, Morse, EAM and orthorhombic-fold kernels; the shipped potentials do not call them (see SIMD). auto uses libhwy >= 1.2, or the highway wrap when its source tree is already unpacked under subprojects/; enabled also downloads it. disabled keeps the scalar kernels.

with_ipi

feature

auto

i-PI socket server Potential (IPIPot), driver client (IPIDriver) and rgpot-ipi-driver (POSIX sockets). auto is on except on Windows.

with_water

boolean

false

Flexible TIP4P, SPC/E and TIP4P-Pt kernels. Defaults false, matching the eOn withwateroption.

with_eam_table

boolean

false

EAM and Finnis-Sinclair potentials read from LAMMPS funcfl, setfl and eam/fs tables.

with_lammps

feature

auto

LAMMPS pairstylergpot and the lj/cut comparison. Needs the lammps Python module. pairstylergpot also needs lammpssrc.

lammps_src

string

(empty)

LAMMPS src directory that contains pair.h, matching the liblammps that will load the plugin.

lammps_exe

string

(empty)

lmp built from lammpssrc. When set, the LAMMPS test also runs pairstylergpot.

with_gromacs

feature

auto

GROMACS mdrun -plumed using the RGPOT collective variable.

with_gromacs_dropin

feature

disabled

librgpotgromacs, the libcp2k API that GROMACS built with -DGMX_CP2K=ON links, so mdrun takes QM/MM energies and forces from any rgpot potential.

gromacs_dropin_gmx

string

(empty)

gmx of a double-precision GROMACS linked against librgpotgromacs. Empty looks for gmxdon PATH and skips the mdrun tests without it.

with_openmm

feature

auto

OpenMM shifted Lennard-Jones comparison.

with_plumed

feature

auto

PLUMED RGPOT collective variable.

with_long_range

boolean

false

Build the Ewald, PME, dispersion and NLH summands (CppCore/rgpot/LongRange).

with_cuda

boolean

false

Compile the long-range CUDA path with nvcc and link cudart. Used only with with_long_range.

CMake

Pass an option as -DNAME=ON or -DNAME=OFF to cmake.

Option

Type

Default

Description

RGPOT_RPC_CLIENT_ONLY

BOOL

OFF

Build only the RPC client bridge. Uses C++17, forces xtensor, Eigen, the cache and the examples off, and forces RGPOT_PURE_LIB on.

RGPOT_WITH_RPC

BOOL

OFF (ON when RGPOT_RPC_CLIENT_ONLY is ON)

Build with Cap’n Proto RPC support.

RGPOT_WITH_XTENSOR

BOOL

OFF

Build with xtensor support.

RGPOT_WITH_EIGEN

BOOL

OFF

Build with Eigen3 support.

RGPOT_PURE_LIB

BOOL

ON

When OFF, link fmt.

RGPOT_WITH_CACHE

BOOL

ON

Build PotentialCache against RocksDB. Unlike Meson, the CMake default is ON, so a CMake build without RocksDB needs -DRGPOT_WITH_CACHE=OFF.

RGPOT_BUILD_EXAMPLES

BOOL

ON when rgpot is the top-level project, else OFF

Build the examples.

RGPOT_WITH_HIGHWAY

BOOL

ON

Google Highway runtime ISA dispatch.

RGPOT_WITH_IPI

BOOL

ON (OFF on Windows)

i-PI socket server potential and driver client. Enabling it on Windows is a configure error.

RGPOT_WITH_EAM_TABLE

BOOL

OFF

EAM and Finnis-Sinclair potentials read from LAMMPS tables.

RGPOT_BUILD_TESTS

BOOL

ON when rgpot is the top-level project, else OFF

Build the tests.

RGPOT_WITH_CP2K

BOOL

OFF

CP2KPot, the potserv CP2K backend and libcp2kc_rgpot against libcp2k.