Skip to content

Commit dbe2f7d

Browse files
committed
Updated the documentation
1 parent af18f98 commit dbe2f7d

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

docs/simulations.rst

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
===============================
55
:code:`ensemble_md` provides three command-line interfaces (CLI), including :code:`explore_EEXE`, :code:`run_EEXE` and :code:`analyze_EEXE`.
66
:code:`explore_EEXE` helps the user to figure out possible combinations of EEXE parameters, while :code:`run_EEXE` and :code:`analyze_EEXE`
7-
can be used to perform and analyze EEXE simulations, respectively. Here is the help message of :code:`explore_EEXE`:
7+
can be used to perform and analyze EEXE simulations, respectively. Below we provide more details about each of these CLIs.
8+
9+
1.1. CLI `explore_EEXE`
10+
-----------------------
11+
Here is the help message of :code:`explore_EEXE`:
812

913
::
1014

@@ -25,7 +29,9 @@ can be used to perform and analyze EEXE simulations, respectively. Here is the h
2529
replicas.
2630

2731

28-
And here is the help message of :code:`run_EEXE`:
32+
1.2. CLI `run_EEXE`
33+
-------------------
34+
Here is the help message of :code:`run_EEXE`:
2935

3036
::
3137

@@ -52,6 +58,18 @@ And here is the help message of :code:`run_EEXE`:
5258
The maximum number of warnings in parameter specification to be
5359
ignored.
5460

61+
In our current implementation, it is assumed that all replicas of an EEXE simulations are performed in
62+
parallel using MPI. Naturally, performing an EEXE simulation using :code:`run_EEXE` requires a command-line interface
63+
to launch MPI processes, such as :code:`mpirun` or :code:`mpiexec`. For example, on a 128-core node
64+
in a cluster, one may use :code:`mpirun -np 4 run_EEXE` (or :code:`mpiexec -n 4 run_EEXE`) to run an EEXE simulation composed of 4
65+
replicas with 4 MPI processes. Note that in this case, it is often recommended to explicitly specify
66+
more details about resources allocated for each replica. For example, one can specifies :code:`{'-nt': 32}`
67+
for the EEXE parameter `runtime_args` (specified in the input YAML file, see :ref:`doc_EEXE_parameters`),
68+
so each of the 4 replicas will use 32 threads (assuming thread-MPI GROMACS), taking the full advantage
69+
of 128 cores.
70+
71+
1.3. CLI `analyze_EEXE`
72+
-----------------------
5573
Finally, here is the help message of :code:`analyze_EEXE`:
5674

5775
::
@@ -210,6 +228,8 @@ include parameters for data analysis here.
210228
- :code:`mdp`: (Required)
211229
The MDP template that has the whole range of :math:`λ` values.
212230

231+
.. _doc_EEXE_parameters:
232+
213233
3.3. EEXE parameters
214234
--------------------
215235

0 commit comments

Comments
 (0)