Skip to content

Commit 073d059

Browse files
committed
update tutorial 1
1 parent 016d41a commit 073d059

1 file changed

Lines changed: 39 additions & 41 deletions

File tree

docs/sphinx/source/tutorials/tutorial1/bulk-solution.rst

Lines changed: 39 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -22,50 +22,48 @@ Bulk salt solution
2222
The objective of this tutorial is to use the open-source code GROMACS
2323
:cite:`van2005gromacs` to perform a molecular dynamics simulation. The
2424
system consists of a bulk solution of water mixed with sodium
25-
(Na\ :sup:`+`) and sulfate (SO\ :sub:`4`\ :sup:`2-`) ions.
25+
(:math:`\text{Na}_+`) and sulfate (:math:`\text{SO}_4^{2-}`) ions.
2626

27-
This tutorial demonstrates how to set up a simulation box, solvate it
28-
with water, and add ions. It also introduces key components of molecular
27+
This tutorial guides you through setting up a simulation box,
28+
adding species to it, and then solvating them with water.
29+
It also introduces key components of molecular
2930
dynamics simulations, including energy minimization, thermostating, and
30-
*NVT* and *NpT* equilibrations. The resulting trajectory is analyzed
31-
using GROMACS utilities to extract properties such as the radial distribution
32-
function (RDF) and mean squared displacement (MSD). Trajectories are
33-
visualized using VMD :cite:`humphrey1996vmd`.
31+
both :math:`NVT` and :math:`NpT` equilibration steps. The resulting trajectory
32+
is analyzed using GROMACS utilities, radial distribution functions are
33+
extracted, and the trajectories are visualized using VMD :cite:`humphrey1996vmd`.
3434

3535
.. include:: ../../non-tutorials/needhelp.rst
3636
.. include:: ../../non-tutorials/GROMACS2024.2.rst
3737

38-
The input files
39-
===============
38+
..
39+
The input files
40+
===============
41+
In order to run the present simulation using GROMACS, we need to
42+
prepare the following three files (or sets of files):
4043
41-
In order to run the present simulation using GROMACS, we need to
42-
prepare the following three files (or sets of files):
44+
- 1) A **configuration file** (**.gro**) containing the initial positions of
45+
the atoms and the box dimensions.
4346

44-
- 1) A **configuration file** (**.gro**) containing the initial positions of
45-
the atoms and the box dimensions.
47+
- 2) A **topology file** (**.top**) specifying the location of the force
48+
field files (**.itp**) and the number of residues in the simulation.
4649

47-
- 2) A **topology file** (**.top**) specifying the location of the force
48-
field files (**.itp**) and the number of residues in the simulation.
50+
- 3) An **input file** (**.mdp**) containing the simulation parameters
51+
(e.g., imposed temperature, timestep, and cut-off values).
4952

50-
- 3) An **input file** (**.mdp**) containing the simulation parameters
51-
(e.g., imposed temperature, timestep, and cut-off values).
53+
..
54+
The specificity of the present tutorial is that both configuration
55+
and topology files were prepared with homemade Python scripts, see
56+
:ref:`create-conf-label`. In principle, it is also possible to
57+
prepare the system using GROMACS functionalities, such as
58+
*gmx pdb2gmx*, *gmx trjconv*, or *gmx solvate*. This will be done
59+
in the next tutorial, :ref:`protein_electrolyte-label`.
5260
53-
..
54-
The specificity of the present tutorial is that both configuration
55-
and topology files were prepared with homemade Python scripts, see
56-
:ref:`create-conf-label`. In principle, it is also possible to
57-
prepare the system using GROMACS functionalities, such as
58-
*gmx pdb2gmx*, *gmx trjconv*, or *gmx solvate*. This will be done
59-
in the next tutorial, :ref:`protein_electrolyte-label`.
60-
61-
1) Populating the box
62-
---------------------
63-
64-
Let us create the simulation box by placing the ions
65-
and molecules into it. To do so, we start from an
66-
empty box. In a dedicated folder, create an empty
67-
file called |empty.gro|, and copy the following lines
68-
into it:
61+
Populating the box
62+
==================
63+
64+
Let us create the simulation box by placing the ions and molecules into it. To do
65+
so, we start from an empty box. In a dedicated folder, create an empty file
66+
called |empty.gro|, and copy the following lines into it:
6967

7068
.. code-block:: bw
7169
@@ -77,19 +75,19 @@ into it:
7775

7876
<a href="https://raw.githubusercontent.com/gromacstutorials/gromacstutorials-inputs/main/tutorial1/empty.gro" target="_blank">empty.gro</a>
7977

80-
The first line, *Cubic box*, is a comment, the second line is the
81-
total number of atoms (0), and the last line is the box dimension in nanometer,
82-
here 3.5 nm by 3.5 nm by 3.5 nm. This **.gro** file is written in Gromos87 format.
78+
The first line, *Cubic box*, is a comment; the second line indicates the total
79+
number of atoms (0); and the last line defines the box dimensions in
80+
nanometers -- in this case, 3.5 by 3.5 by :math:`3.5~\text{nm}`. This **.gro** file
81+
is written in |Gromos87| format.
8382

8483
.. |Gromos87| raw:: html
8584

8685
<a href="https://manual.gromacs.org/archive/5.0.4/online/gro.html" target="_blank">Gromos87</a>
8786

88-
Let us populate this empty box with SO\ :sub:`4`\ :sup:`2-` ions first.
89-
To do so, the GROMACS command named ``insert-molecules`` is used, for which one
90-
needs to provide a template for the ion. Within the same folder as **empty.gro**,
91-
create a new file named |so4.gro|, and copy the following lines
92-
into it:
87+
Let us populate this empty box with :math:`\text{SO}_4^{2-}` ions first. To do so,
88+
the GROMACS command named ``insert-molecules`` is used, for which one needs to
89+
provide a template for the ion. Within the same folder as **empty.gro**, create a
90+
new file named |so4.gro|, and copy the following lines into it:
9391

9492
.. code-block:: bw
9593

0 commit comments

Comments
 (0)