From 9092076a5b3b64c8007f3ac2703f47f7d17ee5cf Mon Sep 17 00:00:00 2001 From: Wei-Tse Hsu Date: Fri, 19 Apr 2024 01:58:42 +0800 Subject: [PATCH] Resolved some documentation errors. --- docs/conf.py | 3 +-- docs/simulations.rst | 9 +++++---- docs/theory.rst | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 8457e558..e5b19160 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,7 +50,6 @@ 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx', 'sphinx.ext.extlinks', - 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'nbsphinx', ] @@ -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), } \ No newline at end of file diff --git a/docs/simulations.rst b/docs/simulations.rst index f5979c24..9a549c61 100644 --- a/docs/simulations.rst +++ b/docs/simulations.rst @@ -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`: :: @@ -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`: :: @@ -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`: :: @@ -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. @@ -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` diff --git a/docs/theory.rst b/docs/theory.rst index aae99f43..da369a7b 100644 --- a/docs/theory.rst +++ b/docs/theory.rst @@ -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)