Skip to content

Commit 7298cd0

Browse files
committed
revise intro and prerequistes
1 parent a54126c commit 7298cd0

1 file changed

Lines changed: 58 additions & 56 deletions

File tree

lammps-tutorials.tex

Lines changed: 58 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ \section{Introduction}
245245
simulation software, they may occasionally be constrained by the
246246
features available in a given package. The tutorials in this
247247
article aim to flatten the learning curve and guide users in
248-
performing accurate, reliable MS with LAMMPS.
248+
performing accurate and reliable molecular simulations with LAMMPS.
249249

250250
\subsection{Scope}
251251

@@ -263,41 +263,40 @@ \subsection{Scope}
263263
In \hyperref[carbon-nanotube-label]{tutorial 2}, a more complex system
264264
is introduced, where atoms are connected by bonds: a small carbon
265265
nanotube. The use of both classical and reactive force fields (here,
266-
AIREBO) is illustrated. An external deformation is applied to the CNT,
267-
and its deformation is measured. This tutorial also demonstrates the use
268-
of an external tool to visualize breaking bonds, and show the possibility
269-
to import LAMMPS-generated YAML log files into Python. %, and
270-
% demonstrates how available LAMMPS features can be used to do the same
271-
% without an external tool. SG: I removed the last part as it not really one
272-
% of the main goal of tutorial 2.
273-
274-
In \hyperref[all-atom-label]{tutorial 3}, two components -
275-
liquid water (flexible three-point model) and a polymer molecule - are merged and equilibrated. A long-range
276-
solver is used to handle the electrostatic interactions accurately, and
277-
the system is equilibrated in the isothermal-isobaric (NPT) ensemble. A
278-
stretching force is applied to the polymer. Through this relatively
279-
complex solvated polymer system, the tutorial demonstrates how to use
280-
type labels to make molecule files more generic and easier to manage~\cite{typelabel_paper}.
281-
282-
In \hyperref[sheared-confined-label]{tutorial 4}, an electrolyte is confined between
283-
two walls, illustrating the specifics of simulating systems
284-
with fluid-solid interfaces. The tutorial uses a slightly more
285-
complex water model than \hyperref[all-atom-label]{tutorial 3}: the rigid
286-
four-point model, TIP4P/2005~\cite{abascal2005general}. Non-equilibrium MD is
287-
performed by imposing shear on the fluid through the moving walls,
288-
and the fluid velocity profile is extracted.
266+
OPLS-AA and AIREBO) is illustrated. An external deformation is applied
267+
to the CNT, and its deformation is measured. This tutorial also
268+
demonstrates the use of an external tool to visualize breaking bonds,
269+
and show the possibility to import LAMMPS-generated YAML log files into
270+
Python.
271+
272+
In \hyperref[all-atom-label]{tutorial 3}, two components - liquid water
273+
(flexible three-point model) and a polymer molecule - are merged and
274+
equilibrated. A long-range solver is used to handle the electrostatic
275+
interactions accurately, and the system is equilibrated in the
276+
isothermal-isobaric (NPT) ensemble; then a stretching force is applied
277+
to the polymer. Through this relatively complex solvated polymer
278+
system, the tutorial demonstrates how to use type labels to make
279+
molecule files more generic and easier to manage~\cite{typelabel_paper}.
280+
281+
In \hyperref[sheared-confined-label]{tutorial 4}, an electrolyte is
282+
confined between two walls, illustrating the specifics of simulating
283+
systems with fluid-solid interfaces. The tutorial uses a slightly more
284+
complex water model than \hyperref[all-atom-label]{tutorial 3}: the
285+
rigid four-point model TIP4P/2005~\cite{abascal2005general}. A
286+
non-equilibrium MD is performed by imposing shear on the fluid through
287+
moving the walls, and the fluid velocity profile is extracted.
289288

290289
In \hyperref[reactive-silicon-dioxide-label]{tutorial 5}, the ReaxFF
291-
reactive force field is used, specifically designed
292-
to simulate chemical reactions by dynamically adjusting
293-
atomic interactions \cite{van2001reaxff}. ReaxFF includes charge equilibration
294-
(QEq), a method that allows the partial charges of atoms
295-
to adjust according to their local environment.
290+
reactive force field is used, specifically designed to simulate chemical
291+
reactions by dynamically adjusting atomic interactions
292+
\cite{van2001reaxff}. ReaxFF includes charge equilibration (QEq), a
293+
method that allows the partial charges of atoms to adjust according to
294+
their local environment.
296295

297296
In \hyperref[gcmc-silica-label]{tutorial 6}, a Monte Carlo simulation in
298-
the Grand Canonical ensemble is implemented to demonstrate how
299-
LAMMPS can be used to simulate an open system that exchange
300-
particles with a reservoir.
297+
the Grand Canonical ensemble is implemented to demonstrate how LAMMPS
298+
can be used to simulate an open system that exchanges particles with a
299+
reservoir.
301300

302301
In \hyperref[umbrella-sampling-label]{tutorial 7}, an advanced free
303302
energy method called umbrella sampling is implemented. By calculating
@@ -318,13 +317,14 @@ \subsection{Background knowledge}
318317
itself. To complete the tutorials, a text editor and a suitable LAMMPS
319318
executable are required. We use \lammpsgui{}~\cite{lammps_gui_docs}
320319
here, as it offers features that make it particularly convenient for
321-
tutorials, but other console or graphical text editors, such as GNU nano,
322-
vi/vim, Emacs, Notepad, Gedit, and Visual Studio Code, can also be
323-
used. LAMMPS can be executed either directly from
324-
\lammpsgui{} (\hyperref[using-lammps-gui-label]{Appendix~\ref{using-lammps-gui-label}})
325-
or from the command-line (\hyperref[command-line-label]{Appendix~\ref{command-line-label}}),
326-
the latter of which requires some familiarity with executing commands
327-
from a terminal or command-line prompt.
320+
tutorials, but other console or graphical text editors, such as GNU
321+
nano, vi/vim, Emacs, Notepad, Gedit, and Visual Studio Code can also be
322+
used. LAMMPS can be executed either directly from \lammpsgui{}
323+
(\hyperref[using-lammps-gui-label]{Appendix~\ref{using-lammps-gui-label}})
324+
or from a command prompt
325+
(\hyperref[command-line-label]{Appendix~\ref{command-line-label}}), the
326+
latter of which requires some familiarity with executing commands from a
327+
terminal or command-line prompt.
328328

329329
In addition, prior knowledge of the theoretical basics of molecular
330330
simulations and statistical physics is highly beneficial. Users may
@@ -343,27 +343,29 @@ \subsection{Background knowledge}
343343

344344
\subsection{Software/system requirements}
345345

346-
The LAMMPS release version 29Aug2024~\cite{lammps_code} and the matching
347-
\lammpsgui{} software version 1.6.11 are required to follow the
348-
tutorials, as they include features that were first introduced in these
349-
versions. For Linux (x86\_64 CPU), macOS (BigSur or later), and Windows
350-
(10 and 11) you can download a precompiled LAMMPS package from the
351-
LAMMPS release page on GitHub~\cite{lammps_github_release}.
352-
Select a package with `GUI' in the file name, which includes both,
353-
\lammpsgui{} and a LAMMPS command-line executable. These precompiled
354-
packages are designed to be portable, and therefore omit support for
355-
parallel execution with MPI. Instructions for installing \lammpsgui{}
356-
and using its most relevant features for the tutorials are provided in
346+
The LAMMPS stable release version 29Aug2024\_update2~\cite{lammps_code}
347+
and the matching \lammpsgui{} software version 1.6.12 are required to
348+
follow the tutorials, as they include features that were first
349+
introduced in these versions. For Linux (x86\_64 CPU), macOS (BigSur or
350+
later), and Windows (10 and 11) you can download a precompiled LAMMPS
351+
package from the LAMMPS release page on
352+
GitHub~\cite{lammps_github_release}. Select a package with `GUI' in the
353+
file name, which includes both, \lammpsgui{} and the LAMMPS command-line
354+
executable. These precompiled packages are designed to be portable, and
355+
therefore omit support for parallel execution with MPI. Instructions
356+
for installing \lammpsgui{} and using its most relevant features for the
357+
tutorials are provided in
357358
\hyperref[using-lammps-gui-label]{Appendix~\ref{using-lammps-gui-label}}.
358359

359360
LAMMPS versions are generally backward compatible, meaning that old
360361
input files typically work with newer versions of LAMMPS. However,
361-
forward compatibility is not as strong, so
362-
newer input files may not work with older versions. As a result, it is
363-
usually possible to follow this tutorial with more recent releases of
364-
\lammpsgui{} and LAMMPS, though older versions may require some minor adjustments.
365-
These tutorials will be periodically updated to ensure compatibility
366-
and take advantage of new features in the latest stable version of LAMMPS.
362+
forward compatibility is not as strong, so input files written for a
363+
newer version may not always work with an older versions. As a result,
364+
it is usually possible to follow this tutorial with more recent releases
365+
of \lammpsgui{} and LAMMPS; older versions may require some (minor)
366+
adjustments. These tutorials will be periodically updated to ensure
367+
compatibility and take advantage of new features in the latest stable
368+
version of LAMMPS.
367369

368370
For some tutorials, external tools are required for plotting and
369371
visualization, as the corresponding functionality in \lammpsgui{} is

0 commit comments

Comments
 (0)