cuEST Release Notes#

v0.3.0#

New Features#

Changes#

  • The cuEST library provides support for basis sets including functions up to g orbitals (L=4 angular momentum). This limit is now strictly enforced. Calls to create integral plans with basis sets including L>4 angular momentum will return CUEST_STATUS_EXCEEDS_MAX_L.

    • The cuestDFIntPlan_t supports up to g orbitals in the primary basis and up to L=8 in the auxiliary basis.

    • This change affects only integral plans. Primitive data structures such as cuestAOShell_t, cuestAOBasis_t and cuestAOPairList_t can still be created with arbitrary angular momentum.

  • Changed the behavior of the cuestAOPairList_t to avoid screening same-center primitive pairs. Only primitive pairs on different centers are subject to the thresholdPQ screening threshold.

  • The variableBufferSize can now be specified without consideration of system size (with reasonable values in the 2GB to 8GB range).

    • This change affects all XC and nonlocal XC compute routines.

    • The workspace buffer sizes (i.e. those returned by workspace query calls) remain dependent on system size and will deviate noticably from the variableBufferSize for large molecules.

  • Improved error handling in some API functions.

    • Certain API functions will now return CUEST_STATUS_INVALID_PLAN if handles to required plans are destroyed too early.

    • cuestDFIntPlanCreate() will now return CUEST_STATUS_INVALID_ARGUMENT for invalid CUEST_DFINTPLAN_PARAMETERS_FITTING_ALGORITHM parameter arguments.

    • cuestXCIntPlanCreate() and cuestXCIntPlanCreateWorkspaceQuery() will now return CUEST_STATUS_INVALID_ARGUMENT if CUEST_XCINTPLAN_PARAMETERS_NUM_THREADS is less than 1.

  • If the cuestDFSymmetricDerivativeCompute() function does not return CUEST_STATUS_SUCCESS, the cuestDFIntPlan_t used to make the call may be marked as invalid. In those cases, subsequent calls using that cuestDFIntPlan_t will return CUEST_STATUS_INVALID_PLAN.

Bug Fixes#

  • Fixed a bug where calls to cuestXCPotentialUKSCompute() could return incorrect results if a density matrix filled with zeros was passed to the routine.

  • The cuestECPDerivativeCompute() function requires a symmetric input density matrix. This is now clarified in the documentation.

v0.2.2#

Enhancements#

  • Improves efficiency on compute capability 8.6, 8.9 and 12.1 GPUs in default math mode (CUEST_DEFAULT_MATH_MODE).

    • Density fitted exchange will use emulation in the default math mode.

Bug Fixes#

  • Fixed a bug in cuestDFSymmetricDerivativeCompute where it returned a spurious CUEST_STATUS_EXCEPTION in cases where the computation should have completed successfully. The bug was localized to cuestDFSymmetricDerivativeCompute and did not affect numerical results of any function calls that returned CUEST_STATUS_SUCCESS.

Changes#

  • Numerical results for density-fitted exchange obtained with compute capability 8.6, 8.9 and 12.1 GPUs will change relative to v0.2.1. These emulated numerical results will be similar to those obtained on other default-emulated GPUs CCs like 9.0 (H100, H200), 10.0 (B200), and 12.0 (RTX PRO 6000 Blackwell). The precision of these results can be controlled by adjusting the emulation parameters.

  • Calls to cuestSetComputeCapabilityTarget() setting unsupported or nonexistent compute capability major/minor versions will disable emulation in subsequent density-fitted exchange calls.

v0.2.1#

Enhancements#

  • Improves efficiency of the caching of just-in-time (JIT) compiled kernels.

  • Modifies the JIT compilation stack to be loaded on demand. This removes a hard dependency on the libcuda.so.1 CUDA driver library, which is usually absent on machines that lack a CUDA-capable GPU.

v0.2.0#

New Features#

  • Adds support for polarizable continuum model (PCM) derivatives with respect to each atomic cavity radius:

  • Adds support for range-separated hybrid exchange and its nuclear derivatives.

    • The cuestDFIntPlan_t can be configured to use the full-range \(1/r\) operator, the long-range \(\mathrm{erf}(\omega r)/r\) operator and linear combinations thereof.

  • Adds native support for new exchange-correlation functionals:

    • \(\mathrm{LC\mbox{-}}\omega\mathrm{PBE}\)

    • \(\mathrm{LC\mbox{-}}\omega\mathrm{PBEh}\)

    • \(\omega\mathrm{B97X}\)

    • \(\omega\mathrm{B97X\mbox{-}V}\)

    • \(\omega\mathrm{B97M\mbox{-}V}\)

    • \(\mathrm{CAM\mbox{-}B3LYP}\)

    • \(\mathrm{HSE06}\)

    • \(\mathrm{M06}\)

    • \(\mathrm{M06\mbox{-}2X}\)

  • Adds support for general multipole integrals and their nuclear derivatives:

  • Adds support for one-electron angular momentum integrals and their nuclear derivatives:

  • Introduces nabla integrals and their nuclear derivatives:

  • Adds density-fitted nonsymmetric exchange (K) matrix computation:

    • cuestDFNonsymmetricExchangeCompute() computes AO exchange (K) matrices with nonsymmetric density matrices (e.g., for response or excited-state methods) within a density fitting (DF) framework.

    • Supports batched evaluation over multiple density matrices. Densities are specified as a single left coefficient matrix and multiple right coefficient matrices.

  • Adds AO-to-MO transformation for density-fitted integrals:

    • cuestDFMOIntegralsCompute() transforms three-index DF AO tensors \((A|mn)\) into MO-space tensors \((A|ia)\) using pairs of left/right coefficient matrices.

    • Supports batched transformations with variable numbers of left and right orbitals per matrix pair.

    • Applies the fitting metric (and, when configured, long-range corrected operators) as part of the transformation.

  • Adds detailed inspection of polarizable continuum model (PCM) calculations:

  • Adds support for float-float FP64 emulation:

    • Accelerates VV10 nonlocal correlation, potential, Coulomb, and PCM computations on GPUs with reduced native FP64 throughput, such as the GeForce and workstation-class architectures (compute capabilities 8.6, 8.9, and 12.0).

    • Defaults to using float-float emulation when beneficial based on the active hardware.

  • Adds just-in-time (JIT) compilation of specialized GPU kernels for select compute routines: cuestPotentialCompute(), cuestPotentialDerivativeCompute(), cuestDFCoulombCompute(), cuestDFSymmetricDerivativeCompute(), cuestPCMPotentialCompute(), cuestPCMDerivativeCompute(), and cuestPCMRadiiDerivativeCompute().

    • Requires CUDA Toolkit 13.x or newer (13.0.2 or later); on CUDA 12.x, affected routines run their precompiled kernels instead.

    • Compiled kernels are cached to disk (default ~/.cuest_cache/cuest-cuda<cuda_major>-v<cuest_version>/) and reused across runs, so the compile cost is paid once per machine.

    • Configurable via CUEST_HANDLE_PARAMETERS_JIT_CACHE_DIR and CUEST_HANDLE_PARAMETERS_JIT_COMPILE_THREADS on the handle parameters, and per-routine via each routine’s *_JIT_USAGE_MODE parameter.

    • See Just-In-Time (JIT) Compilation in cuEST for details.

Changes#

  • To improve efficiency in the cuestDFSymmetricDerivativeCompute(), the cuestDFSymmetricDerivativeComputeMemoryPolicy_t options have been changed.

    • The CUEST_DFSYMMETRICDERIVATIVECOMPUTE_MEMORY_POLICY_FULL and CUEST_DFSYMMETRICDERIVATIVECOMPUTE_MEMORY_POLICY_BLOCKED memory policies have been deprecated.

    • The CUEST_DFSYMMETRICDERIVATIVECOMPUTE_MEMORY_POLICY_DEVICECACHE policy replaces CUEST_DFSYMMETRICDERIVATIVECOMPUTE_MEMORY_POLICY_FULL.

    • If the new CUEST_DFSYMMETRICDERIVATIVECOMPUTE_MEMORY_POLICY_OVERWRITE memory policy is used when cuestDFSymmetricDerivativeCompute() is called, the cuestDFIntPlan_t will be placed in a “dirty” state and cannot continue to be used. Calls using a cuestDFIntPlan_t in a dirty state return the CUEST_STATUS_INVALID_PLAN status code.

  • The cuestDFIntPlan_t can now be constructed in an “integral direct” mode by setting CUEST_DFINTPLAN_PARAMETERS_THREE_INDEX_INTEGRAL_DIRECT.

  • The cuestDFIntPlan_t now only accepts values of CUEST_DFINTPLAN_PARAMETERS_EXCHANGE_FRACTION that are greater than or equal to zero.

    • The CUEST_STATUS_INVALID_ARGUMENT status will be returned if this condition is violated.

  • The cuestDFSymmetricDerivativeCompute functions accept NULL pointers for the MO coefficients if no exchange calculation will be performed.

    • This behavior is now consistent for both the C and Python APIs.

  • Python bindings now use nanobind and the 3.12 stable ABI. This means that Python 3.11 is deprecated and all 3.12+ versions are supported (free threaded Python is not currently supported). While regular usage is unchanged, nanobind introduces some extra type safety preventing, e.g., creation of enum variables from integers that do not correspond to a valid enumerator value.

  • The libcuest, libcuest-static, and libcuest-dev C packages are deployed only through the conda-forge channel from 0.2.0 onwards. Previous versions are still available on both conda-forge and the nvidia channel.

v0.1.1#

Bug Fixes#

Disclaimer#

cuEST is in a pre-release state. Pre-release products may not be fully functional, may contain errors or design flaws, and may be changed at any time without notice. We appreciate your feedback to improve and iterate on our products.