Skip to content

Commit 550f094

Browse files
author
Philipp Pracht
committed
Restructures the sites' source
1 parent f413d1b commit 550f094

28 files changed

+600
-344
lines changed

_data/keywords.yml

Lines changed: 148 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,15 @@ runtype:
7575
Iterative version of the MTD-GC workflow, which is the [default] runtype of CREST.
7676
url:
7777
text: See here.
78-
link: /docs/overview/workflows.html#imtd-gc-algorithm
78+
link: /page/overview/workflows.html#imtd-gc-algorithm
7979

8080
- cmd: --v4
8181
type: iMTD-sMTD sampling
8282
descript: >
8383
Iterative workflow making use of static metadynamics simulations.
8484
url:
8585
text: See here.
86-
link: /docs/overview/workflows.html#conformational-entropy-calculations
86+
link: /page/overview/workflows.html#conformational-entropy-calculations
8787

8888
- cmd: --entropy
8989
type: Confromational Entropy Algorithm
@@ -92,15 +92,15 @@ runtype:
9292
used in the calculation of conformational entropy.
9393
url:
9494
text: See here.
95-
link: /docs/overview/workflows.html#conformational-entropy-calculations
95+
link: /page/overview/workflows.html#conformational-entropy-calculations
9696

9797
- cmd: --protonate
9898
type: Protonation site sampling
9999
descript: >
100100
Workflow for sampling protonation sites.
101101
url:
102102
link: See here.
103-
link: /docs/overview/workflows.html#protonation-site-screening
103+
link: /page/overview/workflows.html#protonation-site-screening
104104

105105
- cmd: --deprotonate
106106
type: Deprotonation site sampling
@@ -121,7 +121,7 @@ runtype:
121121
trajectory into conformers and rotamers.
122122
url:
123123
text: See below. <i class="fa-solid fa-circle-down"></i>
124-
link: /docs/documentation/keywords.html#ensemble-sorting-options
124+
link: /page/documentation/keywords.html#ensemble-sorting-options
125125

126126
- cmd: --qcg
127127
type: QCG tool
@@ -130,21 +130,22 @@ runtype:
130130
QCG has several individual runtypes. See
131131
url:
132132
text: QCG keywords.
133-
link: /docs/documentation/qcg.html
133+
link: /page/documentation/qcg.html
134134

135135

136136
leveloftheory:
137137

138138
- subheader: "**GFN*n*-xTB method selection**"
139139

140140
- cmd: --gfn1
141-
descript: Use GFN1-xTB.
141+
descript: Use [GFN1-xTB](https://doi.org/10.1021/acs.jctc.7b00118)
142142

143143
- cmd: --gfn2
144-
descript: Use GFN2-xTB.
144+
descript: Use [GFN2-xTB](https://doi.org/10.1021/acs.jctc.8b01176)
145145

146146
- comm: "`--gff`, `--gfnff`"
147-
descript: Use GFN-FF.
147+
descript: Use [GFN-FF](https://doi.org/10.1002/anie.202004239)
148+
148149

149150
- cmd: --gfn2//gfnff
150151
descript: >
@@ -175,8 +176,8 @@ leveloftheory:
175176
176177
- cmd: --alpb <SOLVENT>
177178
descript: >
178-
Use the ALPB model, an improved version of GBSA.
179-
For available `<SOLVENT>` options see the
179+
Use the [ALPB model](https://doi.org/10.1021/acs.jctc.1c00471), an improved
180+
version of GBSA. For available `<SOLVENT>` options see the
180181
[`xtb` documentation](https://xtb-docs.readthedocs.io/en/latest/gbsa.html#gbsa).
181182
The solvent input is not case-sensitive.
182183
@@ -296,13 +297,14 @@ confsettings:
296297
some settings are reduced in order to achieve lower computation times. See
297298
url:
298299
text: Example X.
299-
link: /docs/examples/
300+
link: /page/examples/
300301

301302
- cmd: --wscal <REAL>
302303
descript: >
303304
Scale the ellipsoid potential axes generated by the `--nci` mode by factor`<REAL>`.
304305
305306
- subheader: "<br>**Property appendix**"
307+
anchor: propopt
306308

307309
- cmd: --prop hess
308310
descript: >
@@ -327,7 +329,7 @@ confsettings:
327329
with the `--for` command,
328330
url:
329331
text: see below. <i class="fa-solid fa-circle-down"></i>
330-
link: /docs/documentation/keywords.html#standalone-tools
332+
link: /page/documentation/keywords.html#standalone-tools
331333

332334
- subheader: "<br>**Technical settings**"
333335

@@ -344,7 +346,7 @@ confsettings:
344346
Do not confuse with
345347
url:
346348
text: "`--notopo` <i class='fa-solid fa-triangle-exclamation'></i>"
347-
link: /docs/documentation/keywords.html#notopo
349+
link: /page/documentation/keywords.html#notopo
348350

349351

350352
entropysettings:
@@ -388,7 +390,7 @@ entropysettings:
388390
<br>Also works with the `--thermo` option,
389391
url:
390392
text: see below. <i class="fa-solid fa-circle-down"></i>
391-
link: /docs/documentation/keywords.html#standalone-tools
393+
link: /page/documentation/keywords.html#standalone-tools
392394

393395
- cmd: --sthr <REAL>
394396
descript: >
@@ -397,7 +399,7 @@ entropysettings:
397399
<br>Also works with the `--thermo` option,
398400
url:
399401
text: see below. <i class="fa-solid fa-circle-down"></i>
400-
link: /docs/documentation/keywords.html#standalone-tools
402+
link: /page/documentation/keywords.html#standalone-tools
401403

402404
- cmd: --ithr <REAL>
403405
descript: >
@@ -406,7 +408,7 @@ entropysettings:
406408
<br>Also works with the `--thermo` option,
407409
url:
408410
text: see below. <i class="fa-solid fa-circle-down"></i>
409-
link: /docs/documentation/keywords.html#standalone-tools
411+
link: /page/documentation/keywords.html#standalone-tools
410412

411413

412414

@@ -469,7 +471,7 @@ sortingsettings:
469471
searches. See
470472
url:
471473
text: Example X.
472-
link: /docs/examples/
474+
link: /page/examples/
473475

474476
- cmd: --notopo
475477
anchor: notopo
@@ -478,7 +480,7 @@ sortingsettings:
478480
Do not confuse with
479481
url:
480482
text: "`--noreftopo` <i class='fa-solid fa-triangle-exclamation'></i>"
481-
link: "/docs/documentation/keywords.html#noreftopo"
483+
link: "/page/documentation/keywords.html#noreftopo"
482484

483485

484486
pcasettings:
@@ -497,7 +499,7 @@ pcasettings:
497499
See also
498500
url:
499501
text: Example X.
500-
link: /docs/examples/
502+
link: /page/examples/
501503

502504
- cmd: --pccap <INT>
503505
descript: >
@@ -515,6 +517,131 @@ pcasettings:
515517
For the format of `<atomlist>` see
516518
url:
517519
text: this page.
518-
link: /docs/documentation/coords.html#atomlists
520+
link: /page/documentation/coords.html#atomlists
521+
522+
523+
524+
525+
standalonetools:
526+
527+
- cmd: --zsort
528+
type: ZSORT z-matrix sorting
529+
descript: >
530+
The atom order of the given input file is sorted in order to yield a more
531+
consistent z-matrix, *i.e.*, atoms are grouped together according to the
532+
molecular structure (e.g. methyl groups).
533+
534+
- cmd: --mdopt <FILE>
535+
type: MDOPT ensemble optimization
536+
descript: >
537+
Optimize each point on a given trajectory or ensemble file `<FILE>` with GFN*n*–xTB.
538+
539+
- cmd: --screen <FILE>
540+
type: SCREEN ensemble optimization
541+
descript: >
542+
Optimize each point on a given trajectory or ensemble file `<FILE>` with GFNn–xTB.
543+
The resulting ensemble is sorted using the CREGEN routine.
544+
545+
- cmd: --rrhoav <FILE>
546+
type: Thermostatistical frequency contribution for ensembles
547+
descript: >
548+
Calculate the $$\overline{S}$$<sub>msRRHO</sub> contribution for a given ensemble
549+
(similar to the `--mdopt` and `--screen` functions). The number of structures taken
550+
from the ensemble for this calculation is determined dynamically based on their
551+
respective Boltzmann population. The calculation can be modified similar to the
552+
entropy mode, see
553+
url:
554+
test: entropy mode settings. <i class="fa-solid fa-circle-up"></i>
555+
link: /page/documentation/keywords.html#entropy-mode-settings
556+
557+
- comm: "`--rmsd <FILE1> <FILE2>`, `--rmsdheavy <FILE1> <FILE2>`"
558+
type: Atomic RMSD calculation
559+
descript: >
560+
Calculate the RMSD or heavy atom RMSD between two given structures.
561+
Input format of the two structures can be any of the formats that can
562+
be read by CREST, output will always be the RMSD in Ångström.
563+
564+
- cmd: --testtopo <FILE>
565+
type: Topology information
566+
descript: >
567+
Calculate the topology (neighbour lists) for a given input structure and
568+
print info (coordination numbers, neighbors for each atom) to screen.
569+
570+
- cmd: --thermo <FILE>
571+
anchor: thermo
572+
type: Thermostatistical calculations from frequencies
573+
descript: >
574+
Calculate thermo data for given structure. Also requires vibrational frequencies
575+
in the Turbomole format, saved as file called `vibspectrum`. The calculation can
576+
be modified by `--fscal` and `--sthr`, see
577+
url:
578+
test: entropy mode settings. <i class="fa-solid fa-circle-up"></i>
579+
link: /page/documentation/keywords.html#entropy-mode-settings
519580

581+
- comm: "`--for <FILE>`, `--forall <FILE>`"
582+
type: Ensemble processing
583+
descript: >
584+
Calculate some things for the ensemble specified as `<FILE>`.
585+
This option is to be used with the `--prop ...` option
586+
([see above <i class="fa-solid fa-circle-up"></i>](#propopt)).
587+
Also applicable for a standalone use of the
588+
url:
589+
text: '`--cluster` option. <i class="fa-solid fa-circle-up"></i>'
590+
link: /page/documentation/keywords.html#pca-clustering-options
591+
592+
- cmd: --splitfile <FILE> [from] [to]
593+
type: Ensemble file splitting
594+
descript: >
595+
Split an ensemble from `<FILE>` into separate directories for each structure.
596+
`[from]` and `[to]` can optionally be used to select specific structures from
597+
the file or a range of structures. The new directories are collected in a
598+
directory called SPLIT.
599+
600+
601+
constrainment:
602+
603+
- cmd: --cinp <FILE>
604+
descript: >
605+
Specify a `<FILE>` with additional constraints in the xTB syntax.
606+
607+
- cmd: --constrain <atom list>
608+
descript: >
609+
Set up an example file in which the atoms in `<atom list>` shall be constrained.
610+
The file will be called `.xcontrol.sample`. No calculations will be performed and
611+
the run is aborted after this sample is written. The written file can be read
612+
with the `--cinp` option. See
613+
614+
- cmd: --cbonds [REAL]
615+
descript: >
616+
Set up a constraint on all bonds (as detected in the input coordinates topology),
617+
where `[REAL]` optionally can be used to set the force constant
618+
(default value 0.02 *E*<sub>h</sub>).
619+
620+
- cmd: --nocbonds
621+
descript: >
622+
Turn off `-cbonds` (mainly for GFN-FF)
623+
624+
- cmd: --cmetal [REAL]
625+
descript: >
626+
Set up a constraint on all M-X bonds (as detected in the input coordinates,
627+
M = transition metal atom), where `[REAL]` optionally can be used to set the
628+
force constant (default value 0.02 *E*<sub>h</sub>)
629+
630+
- cmd: --cheavy [REAL]
631+
descript: >
632+
Set up a constraint on all heavy atom bonds (*i.e.*, X-H bonds will be
633+
not constrained), where `[REAL]` optionally can be used to set the
634+
force constant (default value 0.02 *E*<sub>h</sub>)
635+
636+
- cmd: --clight [REAL]
637+
descript: >
638+
Set up a constraint on all X-H bonds (as detected in the input
639+
coordinates), where `[REAL]` optionally can be used to set the
640+
force constant (default value 0.02 *E*<sub>h</sub>)
641+
642+
- cmd: --fc <REAL>
643+
descript: >
644+
Specify a force constant for the applied constraints (default
645+
value 0.02 *E*<sub>h</sub>).
646+
Note: Only one force constant is applied for all constraints!
520647

0 commit comments

Comments
 (0)