Skip to content

Commit

Permalink
applied the suggestion proposed by @Puncist
Browse files Browse the repository at this point in the history
  • Loading branch information
Iximiel committed Sep 18, 2024
1 parent fe01b29 commit 013c5dd
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions developer-doc/AddingRegressionTests.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,17 @@ extra_files="../../trajectories/diala_traj_nm.xyz ../trajectories/path_msd/all.
- The first line in this file - the one containing the string mpiprocs=2 - tells PLUMED that when this regtest should be run using MPI on two nodes.
If mpiprocs is not specified then PLUMED will, by default, run the test one node.

- The second line tells PLUMED that the test is to be performed using the command line tool <a href="../../user-doc/html/driver.html">driver</a>.
There are four options that you can use here:
type=driver tells PLUMED to run the test by reading in a trajectory and analysing it using <a href="../../user-doc/html/driver.html">driver</a>,
type=simplemd tells PLUMED that the test will involve
running some Lennard Jones MD using <a href="../../user-doc/html/simplemd.html">simplemd</a>,
type=sum_hills tells PLUMED that the test will involve summing gaussians using the
<a href="../../user-doc/html/sum_hills.html">sum_hills</a> untility
and type=make tells PLUMED that a main function (called main.cpp) is included in the regtest directory and that the test should compile this function, link in
the PLUMED library and run the resulting executible. The vast majority of features are best tested using type=driver here although the type=make function
can be useful for testing tools that are used in many places in the code (see the code in regtest/basic/rt-make-4 for an example of how use type=make to test
PLUMED's internal matrix class). If you need to test PLUMED in a way that is not included in these various types please contact the PLUMED developers before
- The second line tells PLUMED that the test is to be performed using the command line tool <a href="../../user-doc/html/driver.html">driver</a>.
The vast majority of features are best tested using type=driver here although the type=make function can be useful for testing tools that are used in many places in the code (see the code in regtest/basic/rt-make-4 for an example of how use type=make to test PLUMED's internal matrix class). If you need to test PLUMED in a way that is not included in these various types please contact the PLUMED developers before
making any changes.
There are four options that you can use here:
- type=driver tells PLUMED to run the test by reading in a trajectory and analysing it using <a href="../../user-doc/html/driver.html">driver</a>,
- type=simplemd tells PLUMED that the test will involve
running some Lennard Jones MD using <a href="../../user-doc/html/simplemd.html">simplemd</a>,
- type=sum_hills tells PLUMED that the test will involve summing gaussians using the
<a href="../../user-doc/html/sum_hills.html">sum_hills</a> utility
- type=make tells PLUMED that a main function (called main.cpp) is included in the regtest directory and that the test should compile this function, link in
the PLUMED library and run the resulting executible.

- The third line - the one containing the string plumed_modules=adjmat - tells PLUMED that this regtest needs the optional module adjmat to be installed in
order for it to be run. Before trying to run this test PLUMED will thus check whether or not the module is installed. If it is not installed then it will
Expand Down

0 comments on commit 013c5dd

Please sign in to comment.