Skip to content

Commit 97512c4

Browse files
committed
work on the appendix
1 parent 25c83fd commit 97512c4

File tree

1 file changed

+88
-99
lines changed

1 file changed

+88
-99
lines changed

lammps-tutorials.tex

Lines changed: 88 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -3913,7 +3913,7 @@ \subsubsection{Method 2: Umbrella sampling}
39133913
and save it next to \lmpcmd{umbrella-sampling.lmp}. Then, run the WHAM algorithm
39143914
by typing the following command in the terminal:
39153915
\begin{lstlisting}
3916-
./wham -30 30 50 1e-8 119.8 0\
3916+
./wham -30 30 50 1e-8 119.8 0 \
39173917
umbrella-sampling.meta umbrella-sampling.dat
39183918
\end{lstlisting}
39193919
where -30 and 30 are the boundaries, 50 is the number of bins, 1e-8 is the tolerance,
@@ -4253,140 +4253,129 @@ \section{Using LAMMPS--GUI}
42534253
\label{using-lammps-gui-label}
42544254

42554255
\begin{note}
4256-
For the sake of simplicity we will refer during the tutorials to
4257-
keyboard shortcuts using the assignments from Linux and Windows.
4258-
4259-
Users of macOS have to use the ``Command'' key (\cmd) instead of the
4260-
``Ctrl'' key for keyboard shortcuts.
4256+
For simplicity, these tutorials reference keyboard shortcuts
4257+
based on the assignments for Linux and Windows. {macOS} users should
4258+
use the ``Command'' key (\cmd) in place of the
4259+
``Ctrl'' key when using keyboard shortcuts.
42614260
\end{note}
42624261

42634262
\subsection{Installation}
42644263

4265-
Precompiled versions of LAMMPS--GUI exist for Linux, {macOS}, and
4266-
Windows. The Linux version comes in two variants, as compressed tar
4267-
archive (.tar.gz) and as a flatpak \cite{flatpak_home} bundle. The macOS
4268-
version as a .dmg installer image and the Window version is an
4269-
executable Installer package.
4264+
Precompiled versions of LAMMPS--GUI are available for Linux, {macOS}, and
4265+
Windows. The Linux version is provided in two formats: as compressed tar
4266+
archive (.tar.gz) and as a Flatpak bundle \cite{flatpak_home}. The {macOS}
4267+
version is distributed as a .dmg installer image, while the Windows version comes
4268+
as an executable installer package.
42704269

4271-
\subsubsection{Installing Linux .tar.gz variant}
4270+
\subsubsection{Installing the Linux .tar.gz variant}
42724271

4273-
Download the archive, e.g.~LAMMPS-Linux-x86\_64-GUI-XXXXAug2024.tar.gz,
4274-
and unpack it. This will create a folder LAMMPS\_GUI which contains the
4275-
included commands that can be launched directly as ``./lammps-gui'' and
4276-
``./lmp'' for example. Adding this folder to the PATH environment
4277-
variable, will make them available everywhere and without the ``./''
4278-
prefix.
4272+
Download the archive (e.g.,~LAMMPS-Linux-x86\_64-GUI-XXXXAug2024.tar.gz)
4273+
and unpack it. This will create a folder named LAMMPS\_GUI containing the
4274+
included commands, which can be launched directly using ``./lammps-gui'' or
4275+
``./lmp'', for example. Adding this folder to the PATH environment
4276+
variable will make these commands accessible from everywhere, without the
4277+
need for the ``./'' prefix.
42794278

42804279
\subsubsection{Installing Linux .flatpak variant}
42814280

4282-
Download the bundle file and then install it with
4283-
{
4284-
\normalsize
4285-
\begin{verbatim}
4281+
Download the bundle file and then install it using the following command:
4282+
\begin{lstlisting}
42864283
flatpak install --user \
42874284
LAMMPS-Linux-x86_64-GUI-XXXAug2024.flatpak
4288-
\end{verbatim}
4289-
}
4290-
This should integrate LAMMPS--GUI into your desktop environment
4291-
(e.g.~GNOME, KDE, XFCE) and it should appear in the ``Applications''
4292-
menu under ``Science''. Also the ``.lmp'' file extension should have
4293-
been registered to launch LAMMPS--GUI when opening a file with that
4294-
extension in the desktop's file manager.
4295-
4296-
It is possible to launch it from the command line with:
4285+
\end{lstlisting}
4286+
This will integrate LAMMPS--GUI into your desktop environment
4287+
(e.g.,~GNOME, KDE, XFCE) where it should appear in the ``Applications''
4288+
menu under ``Science''. Additionally, the ``.lmp'' file extension will be
4289+
registered to launch LAMMPS--GUI when opening a file with this
4290+
extension in the desktop's file manager. You can then
4291+
launch LAMMPS-GUI from the command line using the following command:
42974292
\begin{lstlisting}
42984293
flatpak run org.lammps.lammps-gui
42994294
\end{lstlisting}
4300-
Similarly for the LAMMPS command line version:
4295+
Similarly, for the LAMMPS command-line version, use:
43014296
\begin{lstlisting}
4302-
flatpak run --command=lmp \
4303-
org.lammps.lammps-gui -in in.melt
4297+
flatpak run --command=lmp org.lammps.lammps-gui -in in.lmp
43044298
\end{lstlisting}
43054299

4306-
\subsubsection{Installing macOS .dmg package}
4300+
\subsubsection{Installing the macOS .dmg package}
43074301

43084302
After downloading the LAMMPS-macOS-multiarch-GUI-XXXAug2024.dmg file,
4309-
you need double-click on it and then drag the LAMMPS\_GUI app bundle
4310-
into the Applications folder shown in the dialog that opens. For
4311-
enabling command line access follow the instructions in the README.txt
4303+
double-click on it and then drag the LAMMPS\_GUI app bundle
4304+
into the Applications folder shown in the dialog that opens. To
4305+
enable command-line access, follow the instructions in the README.txt
43124306
file.
43134307

4314-
After installation, LAMMPS\_GUI can be launched from the Applications
4315-
folder, you can also drag an input file on top of it or open files with
4316-
the ``.lmp'' extension. The LAMMPS--GUI bundle is currently not
4317-
cryptographically signed so macOS may initially refuse to launch it.
4318-
But you can clear its access in the ``Security \& Privacy" system
4319-
setting dialog.
4308+
After installation, you can launch LAMMPS\_GUI from the Applications
4309+
folder. Additionally, you can drag an input file onto the app or open files with the
4310+
``.lmp'' extension. Note that the LAMMPS--GUI bundle is currently not
4311+
cryptographically signed, so macOS may initially prevent it from launching.
4312+
If this happens, you can adjust the settings in the ``Security \& Privacy" system
4313+
preferences dialog to allow access.
43204314

4321-
\subsubsection{Installing Windows .exe package}
4315+
\subsubsection{Installing the Windows .exe package}
43224316

4323-
When downloading the LAMMPS-Win10-64bit-GUI-XXXAug2024.exe installer,
4324-
Windows will suggest to delete the file since it is from an unknown
4325-
developer and downloaded from the internet. This is because neither the
4326-
installer nor the LAMMPS--GUI and other applications inside have been
4327-
cryptographically signed. You have to tell it keep it and when
4328-
launching the installer again confirm that you want to run it anyway.
4317+
Download the LAMMPS-Win10-64bit-GUI-XXXAug2024.exe installer.
4318+
Windows may warn you that the file is from an unknown developer
4319+
and was downloaded from the internet. This happens because neither the
4320+
installer nor the LAMMPS--GUI application (or any other applications inside)
4321+
has been cryptographically signed. You will need to choose to keep the file,
4322+
and when launching the installer again, confirm that you want to run it despite the warning.
43294323

4330-
After installation, there should be a new entry in the start menu and
4331-
also the ``.lmp'' extension should be registered with the Windows File
4324+
After installation, a new entry should appear in the Start menu. Additionally,
4325+
the ``.lmp'' file extension should be registered with Windows File
43324326
Explorer to open LAMMPS--GUI when opening a file with that
4333-
extension. The ``lammps-gui'' and ``lmp'' commands should be available
4334-
on the command line in a Command Prompt or Terminal window as well.
4327+
extension. The ``lammps-gui'' and ``lmp'' commands should also be available
4328+
in the command line, either in a Command Prompt or Terminal window.
43354329

43364330
\subsection{Opening, Editing, and Saving Files}
43374331

4338-
LAMMPS--GUI can be launched from the command line as explained above where you
4339-
can launch it without arguments or provide one file name as argument. All
4340-
other arguments are ignored. Example:
4341-
{
4342-
\normalsize
4343-
\begin{verbatim}
4344-
lammps-gui input.lmp
4345-
\end{verbatim}
4346-
}
4347-
Files can also be opened from the ``File'' menu. There is the option
4348-
to select a file through a dialog and then open it. There is also a
4349-
record of the last five opened files and entries to open them directly.
4350-
Finally, there is the \texttt{Ctrl--O} keyboard shortcut to open a file.
4332+
LAMMPS--GUI can be launched from the command line, as explained above, where you
4333+
can either launch it without arguments or provide one file name as an argument. All
4334+
other arguments will be ignored. For example:
4335+
\begin{lstlisting}
4336+
lammps-gui input.lmp
4337+
\end{lstlisting}
4338+
Files can also be opened from the ``File'' menu. You can select a
4339+
file through a dialog and then open it. Additionally, a history of
4340+
the last five opened files is maintained, with entries to open them directly.
4341+
Finally, the \texttt{Ctrl--O} keyboard shortcut can also be used to open a file.
43514342

4352-
When integrated into a desktop environment, it also possible to open
4353-
files with a ``.lmp'' extension or use drag-n-drop.
4343+
When integrated into a desktop environment, it is also possible to open
4344+
files with a ``.lmp'' extension or use drag-and-drop.
43544345

43554346
For the most part, the editor window behaves like other graphical
4356-
editors. You can enter, delete, and copy and paste text. When entering
4357-
text, for the first word in a line, there will be a pop-up window with
4358-
possible completions after typing the first two characters. You can
4359-
change the highlight with the up and down cursor keys and select a
4360-
completion with the enter key or using the mouse. You can also keep
4361-
typing and the selection in the pop-up will be refined. For some
4362-
commands, there will also be completion pop-ups for some of their
4363-
keywords or if a filename is expected (then the pop-up lists files in
4364-
the current folder).
4365-
4366-
As soon as LAMMPS--GUI recognizes a command line, it will apply syntax
4367-
highlighting according to some built-in categories. This can be used as
4368-
a hint for detecting typos, since those may cause LAMMPS--GUI not to
4369-
recognize the syntax and thus not apply the syntax highlighting or only
4370-
partially. When hitting the \texttt{Tab} key, the line will be
4371-
reformatted. A consistent formatting can improve the readability of
4347+
editors. You can enter, delete, or copy and paste text. When entering
4348+
text, a pop-up window will appear with possible completions after typing
4349+
the first two characters of the first word in a line. You can
4350+
navigate the highlighted options using the up and down arrow keys, and select a
4351+
completion by pressing the Enter key or using the mouse. You can also continue
4352+
typing, and the selection in the pop-up will be refined. For some
4353+
commands, there will be completion pop-ups for their
4354+
keywords or when a filename is expected, in which case,
4355+
the pop-up will list files in the current folder.
4356+
4357+
As soon as LAMMPS--GUI recognizes a command line, it applies syntax
4358+
highlighting according to built-in categories. This can help
4359+
detect typos, since those may cause LAMMPS--GUI not to
4360+
recognize the syntax and thus not apply or partially apply
4361+
the syntax highlighting. When you press the \texttt{Tab} key, the line will be
4362+
reformatted. Consistent formatting can improve the readability of
43724363
input files, especially long and complex ones.
43734364

4374-
If the file in the editor has unsaved changes an additional
4375-
``\*modified\*'' text is shown in the window title. The current input
4376-
buffer can be saved be selection ``Save'' or ``Save As..'' from the
4377-
``File'' menu. You can also click on the ``Save'' icon on the left side
4378-
of the status bar, and finally, there is the \texttt{Ctrl--S} keyboard
4379-
shortcut.
4380-
4365+
If the file in the editor has unsaved changes, the word
4366+
``\*modified\*'' will appear in the window title. The current input
4367+
buffer can be saved by selecting ``Save'' or ``Save As...'' from the
4368+
``File'' menu. You can also click the ``Save'' icon on the left side
4369+
of the status bar, or use the \texttt{Ctrl--S} keyboard shortcut.
43814370

43824371
\begin{note}
4383-
When LAMMPS--GUI is opening a file it will \emph{switch} the working directory
4384-
of the folder that contains the input file. The same happens when saving to
4372+
When LAMMPS--GUI opens a file, it will \emph{switch} the working directory
4373+
to the folder that contains the input file. The same happens when saving to
43854374
a different folder than the current working directory. The current working
4386-
directory can be seen in the status bar on the bottom right. This is important
4387-
to know since LAMMPS input files often require other files for reading and may
4388-
write output files (images, trajectory dumps, averaged data files) and usually
4389-
expects those files to be in the same folder as the input file.
4375+
directory can be seen in the status bar at the bottom right. This is important
4376+
to note because LAMMPS input files often require additional files for reading and may
4377+
write output files (such as images, trajectory dumps, or averaged data files),
4378+
which are typically expected to be in the same folder as the input file.
43904379
\end{note}
43914380

43924381
%The contents of the \textit{Editor} window can be saved by either using

0 commit comments

Comments
 (0)