Skip to content

Commit 79cc8ae

Browse files
committed
minor sentence change + use of hyphenated command-line when necessary
1 parent 8e49ecd commit 79cc8ae

1 file changed

Lines changed: 19 additions & 25 deletions

File tree

lammps-tutorials.tex

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ \subsection{Background knowledge}
324324
vi/vim, Emacs, Notepad, Gedit, and Visual Studio Code, can also be
325325
used. LAMMPS can be executed either directly from
326326
\lammpsgui{} (\hyperref[using-lammps-gui-label]{Appendix~\ref{using-lammps-gui-label}})
327-
or from the command line (\hyperref[command-line-label]{Appendix~\ref{command-line-label}}),
327+
or from the command-line (\hyperref[command-line-label]{Appendix~\ref{command-line-label}}),
328328
the latter of which requires some familiarity with executing commands
329329
from a terminal or command-line prompt.
330330

@@ -352,7 +352,7 @@ \subsection{Software/system requirements}
352352
(10 and 11) you can download a precompiled LAMMPS package from the
353353
LAMMPS release page on GitHub~\cite{lammps_github_release}.
354354
Select a package with `GUI' in the file name, which includes both,
355-
\lammpsgui{} and a LAMMPS command line executable. These precompiled
355+
\lammpsgui{} and a LAMMPS command-line executable. These precompiled
356356
packages are designed to be portable, and therefore omit support for
357357
parallel execution with MPI. Instructions for installing \lammpsgui{}
358358
and using its most relevant features for the tutorials are provided in
@@ -375,11 +375,6 @@ \subsection{Software/system requirements}
375375
suitable external tools include VMD~\cite{vmd_home,humphrey1996vmd}
376376
and OVITO~\cite{ovito_home,ovito_paper}.
377377

378-
% \hyperref[command-line-label]{Appendix~\ref{command-line-label}} has instructions
379-
% for running LAMMPS from the command line.
380-
% SG: I placed a reference of Appendix B before, so I dont think that sentence is
381-
% necessary here.
382-
383378
\subsection{About \lammpsgui{}}
384379

385380
\lammpsgui{} is a graphical text editor, enhanced for editing LAMMPS input
@@ -848,7 +843,7 @@ \subsubsection{My first input}
848843
create snapshot images during the simulation. We have already explored
849844
the \guicmd{Image Viewer} window. Open it again and adjust the
850845
visualization to your liking using the available buttons. Now you can
851-
copy the command line used to create this visualization to the clipboard
846+
copy the commands used to create this visualization to the clipboard
852847
by either using the \guicmd{Ctrl-D} keyboard shortcut or selecting
853848
\guicmd{Copy dump image command} from the \guicmd{File} menu. This text
854849
can be pasted into the into the \lmpcmd{Visualization} section of
@@ -4346,7 +4341,7 @@ \subsubsection{Installing the Linux Flatpak Bundle}
43464341
registered to launch \lammpsgui{} when opening a file with this
43474342
extension in the desktop's file manager.
43484343

4349-
You can also launch \lammpsgui{} from the command line using the following command:
4344+
You can also launch \lammpsgui{} from the command-line using the following command:
43504345
\begin{lstlisting}[language=tcl]
43514346
flatpak run org.lammps.lammps-gui
43524347
\end{lstlisting}
@@ -4386,11 +4381,11 @@ \subsubsection{Installing the Windows package}
43864381
Additionally, the ``.lmp'' file extension should be registered with
43874382
Windows File Explorer to open \lammpsgui{} when opening a file with the
43884383
``.lmp`` extension. The ``lammps-gui'' and ``lmp'' commands should also
4389-
be available in the command line.
4384+
be available in the command-line.
43904385
43914386
\subsection{Opening, Editing, and Saving Files}
43924387
4393-
\lammpsgui{} can be launched from the command line, as explained above, where you
4388+
\lammpsgui{} can be launched from the command-line, as explained above, where you
43944389
can either launch it without arguments or provide one file name as an argument. All
43954390
other arguments will be ignored. For example:
43964391
\begin{lstlisting}[language=tcl]
@@ -4415,7 +4410,7 @@ \subsection{Opening, Editing, and Saving Files}
44154410
keywords or when a filename is expected, in which case,
44164411
the pop-up will list files in the current folder.
44174412
4418-
As soon as \lammpsgui{} recognizes a command line, it applies syntax
4413+
As soon as \lammpsgui{} recognizes a command, it applies syntax
44194414
highlighting according to built-in categories. This can help
44204415
detect typos, since those may cause \lammpsgui{} not to
44214416
recognize the syntax and thus not apply or partially apply
@@ -4515,21 +4510,20 @@ \subsection{Preferences}
45154510
\end{itemize}
45164511
See Ref.\,\citenum{lammps_gui_docs} for a full list of options.
45174512
4518-
\section{Running LAMMPS on the Command Line without the GUI}
4513+
\section{Running LAMMPS on the Command-Line without the GUI}
45194514
\label{command-line-label}
45204515
4521-
LAMMPS can also be executed from the command line on Linux, macOS, and
4516+
LAMMPS can also be executed from the command-line on Linux, macOS, and
45224517
Windows without using the GUI. This is the more common way to run LAMMPS.
4523-
Both, the \lammpsgui{} program and the LAMMPS command line executable
4524-
utilize the same LAMMPS library and thus no changes to the input file should
4525-
be required.
4518+
Both, the \lammpsgui{} program and the LAMMPS command-line executable
4519+
utilize the same LAMMPS library and thus no changes to the input file are required.
45264520
4527-
First open a terminal or command line prompt window and navigate to the
4528-
directory containing the \flecmd{input.lmp} file. Then execute:
4521+
First, open a terminal or command-line prompt window and navigate to the
4522+
directory containing the \flecmd{input.lmp} file. Then execute:
45294523
\begin{lstlisting}[language=tcl]
45304524
lmp -in input.lmp
45314525
\end{lstlisting}
4532-
where \flecmd{lmp} is the command line LAMMPS command.
4526+
where \flecmd{lmp} is the command-line LAMMPS command.
45334527
45344528
For parallel execution with 4 processors (via OpenMP threads where supported
45354529
by the OPENMP package), use:
@@ -4538,11 +4532,11 @@ \section{Running LAMMPS on the Command Line without the GUI}
45384532
\end{lstlisting}
45394533
45404534
\begin{note}
4541-
Running in parallel via MPI requires a correspondingly compiled LAMMPS
4542-
package and is not compatible with the GUI. On supercomputers or HPC
4543-
clusters, pre-compiled LAMMPS executables are often provided by the
4544-
user support staff. Please consult the corresponding documentation of
4545-
the facility or contact its user support for more information.
4535+
Running in parallel via MPI requires a specially compiled LAMMPS
4536+
package and is not supported by the GUI. On supercomputers or HPC
4537+
clusters, pre-compiled LAMMPS executables are typically provided
4538+
by the facility's user support team. For more information, please
4539+
refer to the facility's documentation or contact its user support staff.
45464540
\end{note}
45474541
45484542
See Ref.\,\citenum{lammps_run_docs} for a complete description on how to

0 commit comments

Comments
 (0)