Commit 74529de
committed
List the stability job type in the input YAML reference
input_reference.rst had no mention of `stability` at all, and its job_types example
listed six keys out of twelve, so the only place the feature was documented was
advanced.rst -- which describes behaviour and is not where a user goes to find out
which keys an input file accepts. The feature was therefore discoverable only by
reading the settings module.
`stability` is added to the job type key list and to the example with its default,
and the example now states which keys default to true and which to false, since the
example itself lists a mixture of the two and previously implied that the ones it
omitted were unavailable rather than defaulted.
A short section states what the analysis is, that ARC has implemented it for Gaussian
so far and that other ESSs are not wired up yet, when it runs (once per species, after
that species' freq job, for a TS or for a species whose freq job actually ran
restricted, at a DFT or HF level, with the freq job's checkfile), and what the user
gets back. Which instabilities invalidate analytic frequencies, and what an adopted
verdict does and does not correct, stay in advanced.rst; this section links there
rather than restating them.
The `specific_job_type` interaction is documented because it is a trap. That key
replaces job_types wholesale with a dictionary in which only the named type is true,
so `specific_job_type: stability` is accepted -- stability is a key of
default_job_types, so no InputError is raised -- and then produces nothing at all,
because opt, freq and sp are all false and run_stability_job is only ever reached from
post_freq_actions. bde is special-cased to re-enable opt/fine/freq/sp; stability is
not. Verified against initialize_job_types rather than inferred: specific_job_type
'stability' yields opt False, freq False, sp False, stability True. The reference now
says to request it through job_types and says why.
Deliberately not documented here: which other programs implement a stability analysis
and under what keyword. ORCA and Q-Chem both do, but their exact syntax was not
verified against their manuals for this commit, and an unverified keyword in ARC's
documentation is worse than none. The text is kept to what ARC does.
Also records that the job type now runs in ORCA as well as in Gaussian, that ORCA always
follows an instability it finds, and that the two codes test the same space and agree on
the verdict, with the sector of a restricted reference's instability read off the solution
ORCA relaxes into.1 parent cc48614 commit 74529de
1 file changed
Lines changed: 39 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
223 | 223 | | |
224 | 224 | | |
225 | 225 | | |
| 226 | + | |
226 | 227 | | |
227 | 228 | | |
228 | 229 | | |
| |||
242 | 243 | | |
243 | 244 | | |
244 | 245 | | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
245 | 284 | | |
246 | 285 | | |
247 | 286 | | |
| |||
0 commit comments