Skip to content

Commit 7d70b97

Browse files
authored
Merge pull request #38 from ohearnk/eri-f-func-doc-updates-2
Update ERI f function documentation part 2
2 parents fee1dd0 + 144c89e commit 7d70b97

File tree

3 files changed

+35
-14
lines changed

3 files changed

+35
-14
lines changed

docs/source/additional-docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Running QUICK: DFT Functional Support
2525
=====================================
2626
A list of the available and tested functionals can be found here: `functionals <working_libxc_funcs.html>`_.
2727

28-
*Last updated on 06/19/2024.*
28+
*Last updated on 06/24/2024.*

docs/source/installation-guide.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,12 @@ QUICK-23.03, specifying multiple microarchitectures for HIP version (e.g.
148148
resulting ``quick.hip`` and ``quick.hip.MPI`` executables will only run on a
149149
single AMD GPU architecture.
150150

151+
Build System: CMake Options
152+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
153+
154+
For additional configurations, a full list of available options and their
155+
definitions for the CMake build system can be found here: `cmake options <cmake-options.html>`_.
151156

152-
A full list of available flags and their definitions can be found `here <cmake-options.html>`_.
153157

154158
Testing
155159
-------
@@ -166,7 +170,7 @@ time a new terminal session is opened:
166170
The build system makes use of a shell script (``runtest``, located in
167171
``${QUICK_HOME}/tools`` but will be copied to the installation directory
168172
``QUICK_INSTALL``) for testing QUICK. Below we describe the standard procedure
169-
to carry out tests; but if you are interested, see `here <runtest-options.html>`_
173+
to carry out tests; but if you are interested, see `runtest options <runtest-options.html>`_
170174
for more information on the ``runtest`` script.
171175

172176
Short tests can be run using the ``runtest`` shell script found inside the install directory.
@@ -184,7 +188,8 @@ Similarly, robust testing can be performed as follows.
184188
cd ${QUICK_INSTALL}
185189
./runtest --full
186190
187-
You may now try some hands-on tutorials to learn how to use QUICK `here <hands-on-tutorials.html>`_.
191+
You may now try some hands-on tutorials to learn how to use QUICK
192+
here: `hands-on tutorials <hands-on-tutorials.html>`_.
188193

189194
Uninstallation and Cleaning
190195
---------------------------

docs/source/user-manual.rst

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ followed by an empty line, the molecular coordinates in xyz format, and
66
potentially point charge information after another empty line. Please see the
77
Hands-on Tutorials for details on the input file format.
88

9-
Feel free to ask questions or start a discussion on the Discussions section of our GitHub page: `https://github.com/merzlab/QUICK/discussions <https://github.com/merzlab/QUICK/discussions>`_.
9+
Feel free to ask questions or start a discussion on the Discussions section of our GitHub page:
10+
`https://github.com/merzlab/QUICK/discussions <https://github.com/merzlab/QUICK/discussions>`_.
1011

1112
Units
1213
^^^^^
@@ -38,13 +39,25 @@ Keywords for QUICK Input
3839
2. Density Functional Theory
3940
****************************
4041

41-
QUICK has two built-in DFT methods that do not rely on Libxc:
42+
When DFT is selected as the Hamiltonian, an additional keyword is required to
43+
specify which DFT method to use, followed by optional additional keywords for
44+
DFT-related parameters.
45+
46+
Built-in Methods
47+
----------------
48+
49+
QUICK has two built-in DFT methods:
4250

4351
**BLYP** : Built in BLYP functional (A. D. Becke, Phys. Rev. A 38, 3098 (1988), C. Lee, W. Yang, and R. G. Parr, Phys. Rev. B 37, 785 (1988), B. Miehlich, A. Savin, H. Stoll, and H. Preuss, Chem. Phys. Lett. 157, 200 (1989))
4452

4553
**B3LYP**: Built in B3LYP functional (P. J. Stephens, F. J. Devlin, C. F. Chabalowski, and M. J. Frisch, J. Phys. Chem. 98, 11623 (1994) )
4654

47-
Following functionals use Libxc (version 4.0.4) and can be requested by their popular names:
55+
Functional Support via libxc
56+
----------------------------
57+
58+
Except for the built-in BLYP and B3LYP functionals QUICK makes use of the Libxc
59+
density functional library (version 4.0.4). The following functionals can be
60+
requested by their popular names:
4861

4962
**BP86**: BP86 functional (A. D. Becke, Phys. Rev. A 38, 3098 (1988), J. P. Perdew, Phys. Rev. B 33, 8822 (1986))
5063

@@ -64,22 +77,25 @@ Following functionals use Libxc (version 4.0.4) and can be requested by their po
6477

6578
**PBE0**: PBE0/PBEH functional (C. Adamo and V. Barone, J. Chem. Phys. 110, 6158 (1999), M. Ernzerhof and G. E. Scuseria, J. Chem. Phys. 110, 5029 (1999))
6679

67-
Except for the built-in BLYP and B3LYP functionals QUICK makes use of the Libxc
68-
density functional library (version 4.0.4). All LDA, GGA and hybrid-GGA
69-
functionals available in Libxc can be requested. As a reminder, (hybrid)
70-
meta-GGA and range-separated hybrid functionals are not supported at present.
71-
You must make sure to select a valid combination of exchange and correlation
72-
functionals. A generic Libxc functional can be requested as follows:
80+
All LDA, GGA and hybrid-GGA functionals available in Libxc can be requested. As
81+
a reminder, (hybrid) meta-GGA and range-separated hybrid functionals are not
82+
supported at present. You must make sure to select a valid combination of
83+
exchange and correlation functionals. A generic Libxc functional can be
84+
requested as follows:
7385

7486
**LIBXC=FUNCTIONAL1,FUNCTIONAL2** : Where FUNCTIONAL1 and FUNCTIONAL2 are exchange and correlation functionals. *Note: Spaces near '=' or ',' are not allowed.*
7587

76-
See here for a `list of available functionals in the current QUICK version <working_libxc_funcs.html>`_.
88+
In addition to methods previously noted, a full list of the available and
89+
tested functionals can be found here: `libxc supported functionals in the current QUICK version <working_libxc_funcs.html>`_.
7790

7891
If you are using Libxc in your work, please cite following paper:
7992

8093
`Susi Lehtola, Conrad Steigemann, Micael J.T. Oliveira, and Miguel A.L. Marques, Recent developments
8194
in Libxc - A comprehensive library of functionals for density functional theory, Software X 7, 1 (2018) <https://www.sciencedirect.com/science/article/pii/S2352711017300602?via%3Dihub>`_.
8295

96+
Grimme Dispersion Corrections
97+
-----------------------------
98+
8399
Grimme type dispersion corrections are requested by adding one of the following keywords:
84100

85101
**D2** : use Grimme's D2 dispersion correction in DFT.

0 commit comments

Comments
 (0)