diff --git a/docs/examples/analyze_EEXE.ipynb b/docs/examples/analyze_REXEE.ipynb similarity index 79% rename from docs/examples/analyze_EEXE.ipynb rename to docs/examples/analyze_REXEE.ipynb index f96ee669..76c22543 100644 --- a/docs/examples/analyze_EEXE.ipynb +++ b/docs/examples/analyze_REXEE.ipynb @@ -5,8 +5,14 @@ "id": "cc81ea4a", "metadata": {}, "source": [ - "# Tutorial 2: Analyzing an ensemble of expanded ensemble" + "# Tutorial 2: Analyzing a REXEE simulation" ] + }, + { + "cell_type": "markdown", + "id": "c3014606", + "metadata": {}, + "source": [] } ], "metadata": { diff --git a/docs/examples/run_EEXE.ipynb b/docs/examples/run_REXEE.ipynb similarity index 94% rename from docs/examples/run_EEXE.ipynb rename to docs/examples/run_REXEE.ipynb index c3fd677e..e9d44ff9 100644 --- a/docs/examples/run_EEXE.ipynb +++ b/docs/examples/run_REXEE.ipynb @@ -5,7 +5,7 @@ "id": "87324540", "metadata": {}, "source": [ - "# Tutorial 1: Launching an ensemble of expanded ensemble" + "# Tutorial 1: Launching a REXEE simulation" ] }, { @@ -13,7 +13,7 @@ "id": "b2d9b443", "metadata": {}, "source": [ - "In this tutorial, we will show how one can launch an ensemble of expanded ensemble simulations in parallel using functions in `ensemble_md`. To this end, we will at least need 4 files: one top file (`sys.top`) and one gro file (`sys.gro`) for the system of interest, one mdp file as the template for customizing mdp files for different replicas (`expanded.mdp`), and finally a yaml file speciying the EEXE-relevant parameters (`params.yaml`). \n", + "In this tutorial, we will show how one can launch an ensemble of expanded ensemble simulations in parallel using functions in `ensemble_md`. To this end, we will at least need 4 files: one top file (`sys.top`) and one gro file (`sys.gro`) for the system of interest, one mdp file as the template for customizing mdp files for different replicas (`expanded.mdp`), and finally a yaml file speciying the REXEE-relevant parameters (`params.yaml`). \n", "\n", "In our case, the system of interest is a linear model composed of 4 interaction sites, where the first and last atom have a charge of +0.2 and -0.2, respectively. In `expanded.mdp`, we define 9 alchemical states in total to decouple the van der Waals interactions and coulombic interactions. Our goal is to run an ensemble composed of 4 replicas of expanded ensemble, each of which sample 6 alchemical states, with the shift between adjacent replicas being 1 state. That is, we want replicas 0 to 3 to sample states 0 to 6, 1 to 7, 2 to 8, and 3 to 9, respectively. Each replica will be performed for 5 iterations, with the length of each iteration being 500 steps (i.e. 1 ps). We will use the Metropolis MC scheme to swap replicas, and use exponential averaging with histogram correction for combining weights of exchanging replicas. The histogram cutoff will be set as 1000 to avoid overcorrection and we will swap 2 pairs of replicas in each attempt when possible. All STDOUT will be redirected to `results.txt`. \n", "\n", @@ -33,6 +33,12 @@ "outfile: 'results.txt' # The output file for logging how replicas interact with each other.\n", "```" ] + }, + { + "cell_type": "markdown", + "id": "6cedf8d9", + "metadata": {}, + "source": [] } ], "metadata": { diff --git a/docs/examples/run_EEXE_modify_inputs.ipynb b/docs/examples/run_REXEE_modify_inputs.ipynb similarity index 78% rename from docs/examples/run_EEXE_modify_inputs.ipynb rename to docs/examples/run_REXEE_modify_inputs.ipynb index 4e2798ea..2903fcdb 100644 --- a/docs/examples/run_EEXE_modify_inputs.ipynb +++ b/docs/examples/run_REXEE_modify_inputs.ipynb @@ -5,8 +5,14 @@ "id": "87324540", "metadata": {}, "source": [ - "# Tutorial 3: EEXE for multiple serial mutations" + "# Tutorial 3: REXEE for multiple serial mutations" ] + }, + { + "cell_type": "markdown", + "id": "46970a2d", + "metadata": {}, + "source": [] } ], "metadata": {