forked from plumed/plumed2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Syntax.txt
72 lines (56 loc) · 3.78 KB
/
Syntax.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/**
\page Syntax Getting started
To run PLUMED 2 you need to provide one input file. In this file you specify what it
is that PLUMED should do during the course of the run. Typically this will involve calculating
one or more collective variables, perhaps calculating a function of these CVs
and then doing some analysis of values of your collective variables/functions or running
some free energy method. A very brief introduction to the syntax used in the PLUMED input file
is provided in this <a href="http://www.youtube.com/watch?v=PxJP16qNCYs"> 10-minute video </a>.
Additional material and examples can be also found in the tutorial \ref belfast-1.
Within this input file every line is an instruction for PLUMED to perform some particular action. This could be
the calculation of a colvar, an occasional analysis of the trajectory or a biassing of the dynamics. The first
word in these lines specify what particular action is to be performed. This is then followed by a number of keywords
which provide PLUMED with more details as to how the action is to be performed. These keywords are either single words
(in which they tell PLUMED to do the calculation in a particular way - for example NOPBC tells PLUMED to not use the periodic
bounadry conditions when calculating a particular colvar) or they can be words followed by an equals sign and a comma separated
list _with no spaces_ of numbers or characters (so for example ATOMS=1,2,3,4 tells PLUMED to use atom numbers 1,2,3 and 4 in
the calculation of a particular colvar). Space separated lists can be used instead of commma separated list if the entire list
is enclosed in curly braces (e.g. ATOMS={1 2 3 4}). Please note that you can split commands over multiple lines by using
\ref ContinuationLines.
The most important of these keywords is the label keyword as it is only by using these labels that we can pass data
from one action to another. As an example if you do:
\verbatim
DISTANCE ATOMS=1,2
\endverbatim
(see \ref DISTANCE)
Then PLUMED will do nothing other than read in your input file. In contrast if you do:
\verbatim
DISTANCE ATOMS=1,2 LABEL=d1
PRINT ARG=d1 FILE=colvar STRIDE=10
\endverbatim
(see \ref PRINT)
then PLUMED will print out the value of the distance between atoms 1 and 2 every 10 steps to the file colvar as you have told
PLUMED to take the value calculated by the action d1 and to print it. You can use any character string to label your actions
as long as it does not begin with the symbol \@. Strings beginning with \@ are used by within PLUMED to reference special,
code-generated groups of atoms and to give labels to any Actions for which the user does not provide a label in the input.
Notice that if a word followed by a column is added at the beginning of the line (e.g. pippo:), PLUMED automatically
removes it and adds an equivalent label (LABEL=pippo).
Thus, a completely equivalent result can be obtained with the following shortcut:
\verbatim
d1: DISTANCE ATOMS=1,2
PRINT ARG=d1 FILE=colvar STRIDE=10
\endverbatim
Also notice that all the actions can be labeled, and that many actions besides normal collective variables can define
one or more value, which can be then referred using the corresponding label.
Actions can be referred also with POSIX regular expressions (see \ref Regex) if regex library is available on your system
and detected at configure time.
You can also add \ref comments to the input or set up your input over multiple files and then create a composite input by
\ref includes.
\section units Plumed units
By default the PLUMED inputs and outputs quantities in the following units:
- Energy - kJ/mol
- Length - nanometers
- Time - picoseconds
Unlike PLUMED 1 the units used are independent of the MD engine you are using. If you want to change these units you can do this using the
\subpage UNITS keyword.
*/