Fix spelling errors in user guide.
authorJames W. Barnett <jbarnet4@tulane.edu>
Mon, 13 Jul 2015 15:18:37 +0000 (10:18 -0500)
committerJames W. Barnett <jbarnet4@tulane.edu>
Mon, 13 Jul 2015 15:18:37 +0000 (10:18 -0500)
Fix spelling errors in user guide. Also update spelling to American
English, only because that is what is used in the manual and in other
documentation (e.g.,  neighbour -> neighbor).

Change-Id: Ib11d5be727bef88750a8aa45f2592d10aabb929e

docs/user-guide/cutoff-schemes.rst
docs/user-guide/environment-variables.rst
docs/user-guide/file-formats.rst
docs/user-guide/mdrun-features.rst
docs/user-guide/mdrun-performance.rst

index 5cdfdfd6c0a2de20a405a1ac55e33d81434747ce..5c1bb6fb2009202ddf3a38792251514237c5e3e8 100644 (file)
@@ -7,7 +7,7 @@ on modern CPUs and accelerators, and support nearly all of the
 algorithms used in |Gromacs|.
 
 Before version 4.6, |Gromacs| always used pair-lists based on groups of
-particles. These groups of particles were orginally charge-groups, which were
+particles. These groups of particles were originally charge-groups, which were
 necessary with plain cut-off electrostatics. With the use of PME (or
 reaction-field with a buffer), charge groups are no longer necessary
 (and are ignored in the Verlet scheme). In |Gromacs| 4.6 and later, the
@@ -18,7 +18,7 @@ converted, and for the few cases where it may allow faster simulations
 with bio-molecular systems dominated by water.
 
 Without PME, the group cut-off scheme should generally be combined
-with a buffered pair-list to help avoid artefacts. However, the
+with a buffered pair-list to help avoid artifacts. However, the
 group-scheme kernels that can implement this are much slower than
 either the unbuffered group-scheme kernels, or the buffered
 Verlet-scheme kernels. Use of the Verlet scheme is strongly encouraged
@@ -53,7 +53,7 @@ unbuffered cut-off scheme             default      not by default
 exact cut-off                         shift/switch always
 potential-shift interactions          yes          yes
 potential-switch interactions         yes          yes
-force-switch interations              yes          yes
+force-switch interactions             yes          yes
 switched potential                    yes          yes
 switched forces                       yes          yes
 non-periodic systems                  yes          Z + walls
@@ -86,7 +86,7 @@ the cut-off length each time step. This makes simulations much
 slower. The performance of the Verlet scheme with the new non-bonded
 kernels is independent of system composition and is intended to always
 run with a buffered pair-list. Typically, buffer size is 0 to 10% of
-the cut-off, so you could win a bit of peformance by reducing or
+the cut-off, so you could win a bit of performance by reducing or
 removing the buffer, but this might not be a good trade-off of
 simulation quality.
 
index 419cbda50d5b4e63da94c9ed6937af1b27e01428..f84247a75192fa2c03e5f4fbf89543c9fe4fb8ac 100644 (file)
@@ -9,7 +9,7 @@ listed in the following sections. Most environment variables function
 by being set in your shell to any non-NULL value. Specific
 requirements are described below if other values need to be set. You
 should consult the documentation for your shell for instructions on
-how to set environment variables in the current shell, or in config
+how to set environment variables in the current shell, or in configuration
 files for future shells. Note that requirements for exporting
 environment variables to jobs run under batch control systems vary and
 you should consult your local documentation for details.
index bdadf4723885efd0863e76219f8878dea2d156af..835062578f117196f123d86e222bc9aa77317494 100644 (file)
@@ -210,7 +210,7 @@ The ene file extension stands for binary energy file. It holds the
 energies as generated during your :ref:`gmx mdrun`.
 
 The file can be transformed to a portable energy file (portable
-accross hardware platforms), the :ref:`edr` file using the program
+across hardware platforms), the :ref:`edr` file using the program
 :ref:`gmx eneconv`.
 
 See also :ref:`gmx energy`.
@@ -334,7 +334,7 @@ were removed with ``-ignh``.
 itp
 ---
 
-The itp file extension stands for include toplogy. These files are included in
+The itp file extension stands for include topology. These files are included in
 topology files (with the :ref:`top` extension).
 
 .. _log:
@@ -718,16 +718,16 @@ structure files in the protein databank file format.  The protein
 databank file format describes the positions of atoms in a molecular
 structure. Coordinates are read from the ATOM and HETATM records,
 until the file ends or an ENDMDL record is encountered.
-GROMACS programs can read and write a simlation box in the
+GROMACS programs can read and write a simulation box in the
 CRYST1 entry.
 The pdb format can also be used as a trajectory format:
-several structures, seperated by ENDMDL, can be read from
+several structures, separated by ENDMDL, can be read from
 or written to one file.
 
 Example
 +++++++
 
-An pdb file should look like this::
+A pdb file should look like this::
 
     ATOM      1  H1  LYS     1      14.260   6.590  34.480  1.00  0.00
     ATOM      2  H2  LYS     1      13.760   5.000  34.340  1.00  0.00
@@ -741,7 +741,7 @@ An pdb file should look like this::
 rtp
 ---
 
-The rtp file extension stands for residue toplogy.
+The rtp file extension stands for residue topology.
 Such a file is needed by :ref:`gmx pdb2gmx`
 to make a GROMACS topology for a protein contained in a :ref:`pdb`
 file. The file contains the default interaction type for the 4 bonded
@@ -767,10 +767,10 @@ It is possible to put more than one dihedral on a rotatable bond.
 :ref:`gmx pdb2gmx` sets the number exclusions to 3, which
 means that interactions between atoms connected by at most 3 bonds are
 excluded. Pair interactions are generated for all pairs of atoms which are
-seperated by 3 bonds (except pairs of hydrogens).
+separated by 3 bonds (except pairs of hydrogens).
 When more interactions need to be excluded, or some pair interactions should
 not be generated, an ``[exclusions]`` field can be added, followed by
-pairs of atom names on seperate lines. All non-bonded and pair interactions
+pairs of atom names on separate lines. All non-bonded and pair interactions
 between these atoms will be excluded.
 
 A sample is included below.
index e8724511c97483cb75600d8c7174accef5af4373..36fb27c26b52d643041c04509ce37b0bf6e9ad2d 100644 (file)
@@ -18,10 +18,10 @@ subsets of the molecular system (see :ref:`gmx convert-tpr` and
 :ref:`gmx trjconv`). It is easier to do a correct "single-point" energy
 evaluation with this feature than a 0-step simulation.
 
-Neighbour searching is normally performed for every frame in the
+Neighbor searching is normally performed for every frame in the
 trajectory, since :ref:`gmx mdrun` can no longer assume anything about how the
 structures were generated. If :mdp:`nstlist` is zero, then only one
-neighbour list will be constructed. Naturally, no update or constraint
+neighbor list will be constructed. Naturally, no update or constraint
 algorithms are ever used.
 
 Running a simulation in reproducible mode
@@ -129,7 +129,7 @@ Normally, the length of an MD simulation is best managed through the
 more control is useful. `mdrun -nsteps 100` overrides the [.mdp] file
 and executes 100 steps. `mdrun -maxh 2.5` will terminate the
 simulation shortly before 2.5 hours elapse, which can be useful when
-running under cluster queues (as long as the queueing system does not
+running under cluster queues (as long as the queuing system does not
 ever suspend the simulation).
 
 Running a membrane protein embedding simulation
@@ -143,7 +143,7 @@ long time in a previous simulation. In theory that could be accomplished
 with a procedure similar to genbox, but since lipids are much larger
 than water molecules it will lead to a large vacuum layer between the
 protein and membrane if we remove all molecules where any atom is
-overlapping. Instead, this module works by first artifically shrinking
+overlapping. Instead, this module works by first artificially shrinking
 the protein in the xy-plane, then it removes lipids that overlap with
 a much smaller core, after which we gradually push the protein atoms
 back to their initial positions, while using normal dynamics for the
@@ -152,7 +152,7 @@ rest of the system so lipids adapt to the protein.
 To use membrane embedding, start by building a lipid bilayer that is
 just-so-slightly larger in the xy-plane than what you expect to need
 in the end, and make sure you have enough water outside the membrane
-to accomodate globular domains. Place the protein in the same coordinate
+to accommodate globular domains. Place the protein in the same coordinate
 file (and topology) as your lipid bilayer, and make sure it is in the
 orientation and position you want right in the middle of the bilayer.
 
index c632ab5da5592eb457a717026742b99fc27103c0..07ecf55604abaac415ecd3e2e52073547bdd1091 100644 (file)
@@ -4,7 +4,7 @@ The GROMACS build system and the :ref:`gmx mdrun` tool has a lot of built-in
 and configurable intelligence to detect your hardware and make pretty
 effective use of that hardware. For a lot of casual and serious use of
 :ref:`gmx mdrun`, the automatic machinery works well enough. But to get the
-most from your hardware to maximise your scientific quality, read on!
+most from your hardware to maximize your scientific quality, read on!
 
 Hardware background information
 -------------------------------
@@ -152,7 +152,7 @@ log file, stdout and stderr are used to print diagnostics that
 inform the user about the choices made and possible consequences.
 
 A number of command-line parameters are available to vary the default
-behaviour.
+behavior.
 
 ``-nt``
     The total number of threads to use. The default, 0, will start as
@@ -168,7 +168,7 @@ behaviour.
 ``-ntomp``
     The total number of OpenMP threads per rank to start. The
     default, 0, will start one thread on each available core.
-    Alternatively, mdrun will honour the appropriate system
+    Alternatively, mdrun will honor the appropriate system
     environment variable (e.g. ``OMP_NUM_THREADS``) if set.
 
 ``-npme``
@@ -460,7 +460,7 @@ parallel hardware.
     comes for free with the non-bonded communication. Particles beyond
     the non-bonded cut-off are only communicated when they have
     missing bonded interactions; this means that the extra cost is
-    minor and nearly indepedent of the value of ``-rdd``. With dynamic
+    minor and nearly independent of the value of ``-rdd``. With dynamic
     load balancing, option ``-rdd`` also sets the lower limit for the
     domain decomposition cell sizes. By default ``-rdd`` is determined
     by :ref:`gmx mdrun` based on the initial coordinates. The chosen value will