Skip to content

Commit

Permalink
Resolved some documentation errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
wehs7661 committed Apr 18, 2024
1 parent bf5da7e commit 9092076
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'nbsphinx',
]
Expand Down Expand Up @@ -188,5 +187,5 @@

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
"pymbar": ("https://pymbar.readthedocs.io/en/latest/", None),
'alchemlyb': ('https://alchemlyb.readthedocs.io/en/latest/', None),
}
9 changes: 5 additions & 4 deletions docs/simulations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
can be used to perform and analyze REXEE simulations, respectively. Below we provide more details about each of these CLIs.

1.1. CLI :code:`explore_REXEE`
-----------------------------
------------------------------
Here is the help message of :code:`explore_REXEE`:

::
Expand All @@ -32,7 +32,7 @@ Here is the help message of :code:`explore_REXEE`:


1.2. CLI :code:`run_REXEE`
-------------------------
--------------------------
Here is the help message of :code:`run_REXEE`:

::
Expand Down Expand Up @@ -71,7 +71,7 @@ so each of the 4 replicas will use 32 threads (assuming thread-MPI GROMACS), tak
of 128 cores.

1.3. CLI :code:`analyze_REXEE`
-----------------------------
------------------------------
Finally, here is the help message of :code:`analyze_REXEE`:

::
Expand Down Expand Up @@ -258,7 +258,7 @@ include parameters for data analysis here.
.. _doc_REXEE_parameters:

3.3. REXEE parameters
--------------------
---------------------

- :code:`n_sim`: (Required)
The number of replica simulations.
Expand Down Expand Up @@ -425,6 +425,7 @@ MDP parameters:
can be observed in a fixed-weight REXEE simulation and the equilibration time may be much longer for a weight-updating
REXEE simulation. To ensure the same reference distance across all iterations in an REXEE simulation, consider the
following scenarios:

- If you would like to use the COM distance between the pull groups in the input GRO file as the reference distance
for all the iterations (whatever that value is), then specify :code:`pull_coord1_start = yes` with
:code:`pull_coord1_init = 0` in your input MDP template. In this case, :obj:`.update_MDP` will parse :code:`pullx.xvg`
Expand Down
4 changes: 2 additions & 2 deletions docs/theory.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _doc_basic_idea:

.. note:: This page is still a work in progress. Please check `Issue 33`_ for the current progress.

.. _`Issue 33`: https://github.com/wehs7661/ensemble_md/issues/33

.. _doc_basic_idea:

1. Basic idea
=============
Replica exchange of expanded ensemble (REXEE) integrates the core principles of replica exchange (REX)
Expand Down

0 comments on commit 9092076

Please sign in to comment.