Skip to content

Commit 3527e7c

Browse files
committed
Documentation: QM options in the input file
Hopefully this is clear. Highlighted the external programs linked with QM (Gaussian, MOPAC, RDKit). Also gave an example script to include in the input file.
1 parent eab43ce commit 3527e7c

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

documentation/source/users/rmg/input.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,36 @@ The following is an example of a simple reactor system::
213213
On the fly Quantum Calculations
214214
===============================
215215

216+
This block is used when quantum mechanical calculations are desired to determine thermodynamic parameters.
217+
These calculations are only run if the molecule is not included in a specified thermo library.
218+
The ``onlyCyclics`` option, if ``True``, only runs these calculations for cyclic species.
219+
In this case, group additive estimates are used for all other species.
220+
221+
Molecular geometries are estimated via RDKit [RDKit]_.
222+
Either MOPAC (2009 and 2012) or GAUSSIAN (2003 and 2009) can be used
223+
with the semi-empirical pm3, pm6, and pm7 (pm7 only available in MOPAC2012),
224+
specified in the software and method blocks.
225+
A folder can be specified to store the files used in these calculations,
226+
however if not specified this defaults to a `QMfiles` folder in the output folder.
227+
228+
The calculations are also only run on species with a maximum radical number set by the user.
229+
If a molecule has a higher radical number, the molecule is saturated with hydrogen atoms, then
230+
quantum mechanical calculations with subsequent hydrogen bond incrementation is used to determine the
231+
thermodynamic parameters.
232+
233+
The following is an example of the quantum mechanics options ::
234+
235+
quantumMechanics(
236+
software='mopac',
237+
method='pm3',
238+
fileStore='QMfiles',
239+
scratchDirectory = None,
240+
onlyCyclics = True,
241+
maxRadicalNumber = 0,
242+
)
243+
244+
.. [RDKit] RDKit: Open-source cheminformatics; http://www.rdkit.org
245+
216246
Pressure Dependence
217247
===================
218248

0 commit comments

Comments
 (0)