From 4e95db1bb791b69817fd7f83cc77d28d6be3333d Mon Sep 17 00:00:00 2001 From: Ajinkya Hire Date: Tue, 26 Mar 2024 12:34:29 -0400 Subject: [PATCH] Added uf3 details to Commands_pair, Packages_details and Packages_list --- doc/src/Commands_pair.rst | 1 + doc/src/Packages_details.rst | 26 ++++++++++++++++++++++++++ doc/src/Packages_list.rst | 5 +++++ 3 files changed, 32 insertions(+) diff --git a/doc/src/Commands_pair.rst b/doc/src/Commands_pair.rst index 9bbe216dec..b804afdfc0 100644 --- a/doc/src/Commands_pair.rst +++ b/doc/src/Commands_pair.rst @@ -302,6 +302,7 @@ OPT. * :doc:`tip4p/long/soft (o) ` * :doc:`tri/lj ` * :doc:`ufm (got) ` + * :doc:`uf3 (k) ` * :doc:`vashishta (gko) ` * :doc:`vashishta/table (o) ` * :doc:`wf/cut ` diff --git a/doc/src/Packages_details.rst b/doc/src/Packages_details.rst index a3d65d9d65..edac1ee3f3 100644 --- a/doc/src/Packages_details.rst +++ b/doc/src/Packages_details.rst @@ -84,6 +84,7 @@ page gives those details. * :ref:`ML-QUIP ` * :ref:`ML-RANN ` * :ref:`ML-SNAP ` + * :ref:`ML-UF3 ` * :ref:`MOFFF ` * :ref:`MOLECULE ` * :ref:`MOLFILE ` @@ -1925,6 +1926,31 @@ computes which analyze attributes of the potential. ---------- +.. _PKG-ML-UF3: + +ML-UF3 package +-------------- + +**Contents:** + +A pair style for the Ultra-Fast Forcefield potentials (UF3). UF3 is a +methodology for deriving a highly accurate classical potential which is fast to +evaluate and is fitted to a large archives of quantum mechanical (DFT) data. +The use of bspline basis set in UF3 enables the rapid evaluation of 2-body and +3-body interactions. + +**Authors:** Ajinkya C Hire (University of Florida), +Hendrik Krass (University of Constance), +Matthias Rupp (Luxembourg Institute of Science and Technology), +Richard Hennig (University of Florida) + +**Supporting info:** + +* src/ML-UF3: filenames -> commands +* :doc:`pair_style uf3 ` +* examples/uf3 +* https://github.com/uf3/uf3 + .. _PKG-MOFFF: MOFFF package diff --git a/doc/src/Packages_list.rst b/doc/src/Packages_list.rst index c0a1164513..e86e43e9ce 100644 --- a/doc/src/Packages_list.rst +++ b/doc/src/Packages_list.rst @@ -318,6 +318,11 @@ whether an extra library is needed to build and use the package: - :doc:`pair_style snap ` - snap - no + * - :ref:`ML-UF3 ` + - quantum-fitted ultra fast potentials + - :doc:`pair_style uf3 ` + - uf3 + - no * - :ref:`MOFFF ` - styles for `MOF-FF `_ force field - :doc:`pair_style buck6d/coul/gauss `