Skip to content

Commit 3ea83ef

Browse files
committed
improved grammar tutorial 1
1 parent 073d059 commit 3ea83ef

1 file changed

Lines changed: 36 additions & 34 deletions

File tree

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

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Bulk salt solution
88
The very basics of GROMACS through a simple example
99

1010
.. figure:: figures/video-solution-white.webp
11-
:alt: Water solution of SO\ :sub:`4`\ :sup:`2-` and Na\ :sup:`+` ions visualized with VMD
11+
:alt: Water solution of :math:`\text{SO}_4^{2-}` and :math:`\text{Na}_+` ions visualized with VMD
1212
:class: only-light
1313
:height: 250
1414
:align: right
1515

1616
.. figure:: figures/video-solution-dark.webp
17-
:alt: Water solution of SO\ :sub:`4`\ :sup:`2-` and Na\ :sup:`+` ions visualized with VMD
17+
:alt: Water solution of :math:`\text{SO}_4^{2-}` and :math:`\text{Na}_+` ions visualized with VMD
1818
:class: only-dark
1919
:height: 250
2020
:align: right
@@ -104,10 +104,11 @@ new file named |so4.gro|, and copy the following lines into it:
104104

105105
<a href="https://raw.githubusercontent.com/gromacstutorials/gromacstutorials-inputs/main/tutorial1/so4.gro" target="_blank">so4.gro</a>
106106

107-
This topology file for the SO\ :sub:`4`\ :sup:`2-` ion is written in the same
107+
This topology file for the :math:`\text{SO}_4^{2-}` ion is written in the same |Gromos87|
108108
format as **empty.gro**. It contains 5 atoms named ``O1``, ``O2``, ``O3``, ``O4``,
109-
and ``S1``, all grouped in a residue called ``SO4``. Then, let us call the
110-
``insert-molecules`` command by typing in the terminal:
109+
and ``S1``, all grouped in a residue called ``SO4``.
110+
111+
Let us call the ``gmx insert-molecules`` command by typing in the terminal:
111112

112113
.. code-block:: bw
113114
@@ -116,16 +117,16 @@ and ``S1``, all grouped in a residue called ``SO4``. Then, let us call the
116117
Here, the ``insert-molecules`` command of GROMACS uses **empty.gro** as an input (flag ``-f``),
117118
and create a new **.gro** file named **conf.gro** (flag ``-o``) with 6 ions in it (flag ``-nmol``).
118119
The ``-radius 0.5`` option is used to prevent ions for being inserted closer than
119-
:math:`0.5~\text{nm}` from each others. The output should indicate that the
120+
:math:`0.5~\text{nm}` from each other. The output should indicate that the
120121
insertion were successful:
121122

122123
.. code-block:: bw
123124
124125
Added 6 molecules (out of 6 requested)
125126
Writing generated configuration to conf.gro
126127
127-
Looking at the generated the **conf.gro** file, it contains
128-
30 atoms corresponding to the 6 ions:
128+
Looking at the generated **conf.gro** file, it contains 30 atoms corresponding
129+
to the 6 ions:
129130

130131
.. code-block:: bw
131132
@@ -144,27 +145,28 @@ Looking at the generated the **conf.gro** file, it contains
144145
6SO4 S1 30 1.205 3.313 0.568
145146
3.50000 3.50000 3.50000
146147
147-
Between the second and the
148-
last lines, there is one line per
149-
atom. Each line indicates, from left to right:
148+
Between the second and the last lines, there is one line per atom. Each line
149+
indicates, from left to right:
150150

151-
- the residue ID, with all the atoms from the same
152-
SO\ :sub:`4`\ :sup:`2-` ion sharing the same residue ID,
153-
- the residue name,
154-
- the atom name,
155-
- the atom ID,
156-
- the atom position: :math:`x`, :math:`y`, and :math:`z` coordinates in nanometer.
151+
- the residue ID, with all 5 atoms from the same :math:`\text{SO}_4^{2-}` ion
152+
sharing the same residue ID,
153+
- the residue name (SO4),
154+
- the atom name (O1, O2, O3, O4, or S1),
155+
- the atom ID (1 to 30),
156+
- the atom position: :math:`x`, :math:`y`, and :math:`z` coordinates in
157+
nanometers.
157158

158-
The format of a **.gro** file is fixed, and each column is in a
159-
fixed position. The generated **conf.gro** file can be visualized
160-
using VMD by typing in the terminal:
159+
The format of a **.gro** file is fixed, and each column is in a fixed position.
160+
161+
The generated **conf.gro** file can be visualized using VMD by typing in the
162+
terminal:
161163

162164
.. code-block:: bash
163165
164166
vmd conf.gro
165167
166-
Then, download the |na.gro| template for the Na\ :sup:`+` ion
167-
and add 12 ions using the same command:
168+
Then, download the |na.gro| template for the :math:`\text{Na}_+` ion and add
169+
12 ions using the same command:
168170

169171
.. code-block:: bw
170172
@@ -176,8 +178,8 @@ and add 12 ions using the same command:
176178

177179
Here, importantly, the same **conf.gro** file is used as input (``-f``) and
178180
output (``-o``), so the 12 ions will be added to the same file. Finally,
179-
download the |h2o.gro| template for the :math:`\text{H}_2\text{O}` molecule
180-
and add 800 molecules using the same command:
181+
download the |h2o.gro| template for the :math:`\text{H}_2\text{O}` molecule and
182+
add 800 molecules using the same command:
181183

182184
.. code-block:: bw
183185
@@ -206,23 +208,23 @@ The final **conf.gro** file contains :
206208
3.50000 3.50000 3.50000
207209
208210
.. figure:: ../figures/level1/bulk-solution/step0-light.png
209-
:alt: Gromacs initial configuration of SO\ :sub:`4`\ :sup:`2-` and Na\ :sup:`+` ions visualized with VMD
211+
:alt: Gromacs initial configuration of :math:`\text{SO}_4^{2-}` and :math:`\text{Na}_+` ions visualized with VMD
210212
:class: only-light
211213

212214
.. figure:: ../figures/level1/bulk-solution/step0-dark.png
213-
:alt: Gromacs initial configuration of SO\ :sub:`4`\ :sup:`2-` and Na\ :sup:`+` ions visualized with VMD
215+
:alt: Gromacs initial configuration of :math:`\text{SO}_4^{2-}` and :math:`\text{Na}_+` ions visualized with VMD
214216
:class: only-dark
215217

216218
.. container:: figurelegend
217219

218-
Figure: SO\ :sub:`4`\ :sup:`2-` ions, Na\ :sup:`+` ions, and water molecules.
220+
Figure: :math:`\text{SO}_4^{2-}` ions, :math:`\text{Na}_+` ions, and water molecules.
219221
Oxygen atoms are in red, hydrogen in white, sodium in blue, and sulfur in
220-
yellow. For better rendering, the atom representation and colors
221-
were modified with respect to the default VMD representation.
222+
yellow. For better rendering, the atom representation and colors were
223+
modified with respect to the default VMD representation.
222224

223-
As can be seen using VMD, the water molecules are
224-
arranged in a quite unrealistic and regular manner.
225-
This will need to be fixed during energy minimization.
225+
As can be seen using VMD, the water molecules are arranged in a quite
226+
unrealistic manner, with some molecules being too close. This will need to be
227+
fixed during energy minimization.
226228

227229
2) Choose the potential
228230
-----------------------
@@ -258,7 +260,7 @@ folder (see below).
258260

259261
The rest of the **topol.top** file contains the system
260262
name (here, *Na2SO4 solution*), and the list of the residues. Here, there
261-
are 6 SO\ :sub:`4`\ :sup:`2-` ions, 12 Na\ :sup:`+` ions,
263+
are 6 :math:`\text{SO}_4^{2-}` ions, 12 :math:`\text{Na}_+` ions,
262264
and 700 water molecules.
263265

264266
.. admonition:: About topol.top
@@ -332,7 +334,7 @@ four-point water model (D).
332334
Finally, the **h2o.itp**, **na.itp**, and **so4.itp** files contain information
333335
about the residues, such as their exact compositions, which pairs of
334336
atoms are connected by bonds as well as the parameters for these bonds.
335-
In the case of the SO\ :sub:`4`\ :sup:`2-`,
337+
In the case of the :math:`\text{SO}_4^{2-}`,
336338
for instance, the sulfur atom forms a bond of equilibrium distance
337339
:math:`0.152~\text{nm}`
338340
and rigidity constant :math:`3.7656 \mathrm{e}4 ~ \text{kJ/mol/nm}^2`

0 commit comments

Comments
 (0)