Skip to content

Commit b54da66

Browse files
committed
doc: urge users the importance of specifying names for sub-CVs
Some users don't specify the names of sub-CVs when using aspathCV, azpathCV, gspathCV and gzpathCV, which cause unexpected results. I have to update the documentation to state the necessity of explicitly specifying the names.
1 parent 54ae9ab commit b54da66

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/colvars-refman-main.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3317,7 +3317,7 @@
33173317
\cvsubsubsec{\texttt{gspathCV}: progress along a path defined in CV space.}{sec:cvc_gspathCV}
33183318
\labelkey{colvar|gspathCV}
33193319

3320-
In the \texttt{gspathCV~\{...\}} and the \texttt{gzpathCV~\{...\}} block all vectors, namely $\mathbf{z}$ and $\mathbf{s}_{k}$ are defined in CV space. More specifically, $\mathbf{z} = \left[{\xi}_{1}, \cdots, {\xi}_{n}\right]$, where ${\xi}_{i}$ is the $i$-th CV. $\mathbf{s}_{k} = \left[{\xi}_{k,1}, \cdots, {\xi}_{k,n}\right]$, where ${\xi}_{k,i}$ means the $i$-th CV of the $k$-th reference frame. It should be note that these two CVs requires the \texttt{pathFile} option, which specifies a path file. Each line in the path file contains a set of space-seperated CV value of the reference frame. The sequence of reference frames matches the sequence of the lines.
3320+
In the \texttt{gspathCV~\{...\}} and the \texttt{gzpathCV~\{...\}} block all vectors, namely $\mathbf{z}$ and $\mathbf{s}_{k}$ are defined in CV space. More specifically, $\mathbf{z} = \left[{\xi}_{1}, \cdots, {\xi}_{n}\right]$, where ${\xi}_{i}$ is the $i$-th CV. $\mathbf{s}_{k} = \left[{\xi}_{k,1}, \cdots, {\xi}_{k,n}\right]$, where ${\xi}_{k,i}$ means the $i$-th CV of the $k$-th reference frame. It should be note that these two CVs requires the \texttt{pathFile} option, which specifies a path file. Each line in the path file contains a set of space-seperated CV value of the reference frame. The sequence of reference frames matches the sequence of the lines. The values of sub-CVs defined in \texttt{gspathCV~\{...\}} and the \texttt{gzpathCV~\{...\}} are passed as $\mathbf{z}$ \textbf{by their sorted names}. It is very important to manually specify the \texttt{name} fields of the sub-CVs, and if the \texttt{name} fields are not specified, Colvars would assign default names to sub-CVs, which would yield unexpected behavior.
33213321

33223322

33233323
\begin{cvcoptions}
@@ -3450,7 +3450,7 @@
34503450

34513451
\cvsubsubsec{\texttt{aspathCV}: progress along a path defined in CV space.}{sec:cvc_aspathCV}
34523452

3453-
This colvar component computes the $s$ variable.
3453+
This colvar component computes the $s$ variable. The values of sub-CVs are passed \textbf{by their sorted names}. It is very important to manually specify the \texttt{name} fields of the sub-CVs, and if the \texttt{name} fields are not specified, Colvars would assign default names to sub-CVs, which would yield unexpected behavior.
34543454

34553455
\labelkey{colvar|aspathCV}
34563456

@@ -3488,7 +3488,7 @@
34883488

34893489
\cvsubsubsec{\texttt{azpathCV}: distance from a path defined in CV space.}{sec:cvc_azpathCV}
34903490

3491-
This colvar component computes the $z$ variable. Options are the same as in \ref{sec:cvc_aspathCV}.
3491+
This colvar component computes the $z$ variable. Options are the same as in \ref{sec:cvc_aspathCV}. The values of sub-CVs are passed \textbf{by their sorted names}. It is very important to manually specify the \texttt{name} fields of the sub-CVs, and if the \texttt{name} fields are not specified, Colvars would assign default names to sub-CVs, which would yield unexpected behavior.
34923492

34933493
The usage of \texttt{azpathCV} and \texttt{aspathCV} is illustrated below:
34943494

@@ -3670,7 +3670,7 @@
36703670

36713671
This colvar component computes a non-linear combination of other scalar colvar components, where the transformation is defined by a dense neural network.\cite{Chen2022}
36723672
The network can be optimized using any framework, and its parameters are provided to Colvars in plain text files, as detailed below.
3673-
An example Python script to export the parameters of a TensorFlow model is provided in \texttt{colvartools/extract\_weights\_biases.py} in the Colvars source tree.
3673+
An example Python script to export the parameters of a TensorFlow model is provided in \texttt{colvartools/extract\_weights\_biases.py} in the Colvars source tree. The values of sub-CVs are passed \textbf{by their sorted names}. It is very important to manually specify the \texttt{name} fields of the sub-CVs, and if the \texttt{name} fields are not specified, Colvars would assign default names to sub-CVs, which would yield unexpected behavior.
36743674

36753675
\begin{figure}[!ht]
36763676
\centering

0 commit comments

Comments
 (0)