diff --git a/doc/src/Howto_lammps_gui.rst b/doc/src/Howto_lammps_gui.rst index 4db8b532ce..165ed84d95 100644 --- a/doc/src/Howto_lammps_gui.rst +++ b/doc/src/Howto_lammps_gui.rst @@ -5,11 +5,14 @@ This document describes **LAMMPS GUI version 1.5**. ----- -LAMMPS GUI is a graphical text editor that is linked to the :ref:`LAMMPS -library ` and thus can run LAMMPS directly using the -contents of the editor's text buffer as input. It can retrieve and -display information from LAMMPS while it is running and is adapted in -multiple ways specifically for editing LAMMPS input files. +LAMMPS GUI is a graphical text editor customized for editing LAMMPS +input files that is linked to the :ref:`LAMMPS library ` +and thus can run LAMMPS directly using the contents of the editor's text +buffer as input. It can retrieve and display information from LAMMPS +while it is running, display visualizations created with the :doc:`dump +image command `, and is adapted specifically for editing +LAMMPS input files through text completion and reformatting, and linking +to the online LAMMPS documentation for known LAMMPS commands and styles. .. note:: diff --git a/doc/src/Tools.rst b/doc/src/Tools.rst index 2e8bd3eac4..a42e7c56a5 100644 --- a/doc/src/Tools.rst +++ b/doc/src/Tools.rst @@ -645,9 +645,14 @@ LAMMPS GUI Overview ^^^^^^^^ -LAMMPS GUI is a simple graphical text editor that is linked to the -:ref:`LAMMPS C-library interface ` and thus can run LAMMPS -directly using the contents of the editor's text buffer as input. +LAMMPS GUI is a graphical text editor customized for editing LAMMPS +input files that is linked to the :ref:`LAMMPS C-library ` +and thus can run LAMMPS directly using the contents of the editor's text +buffer as input. It can retrieve and display information from LAMMPS +while it is running, display visualizations created with the :doc:`dump +image command `, and is adapted specifically for editing +LAMMPS input files through text completion and reformatting, and linking +to the online LAMMPS documentation for known LAMMPS commands and styles. This is similar to what people traditionally would do to run LAMMPS: using a regular text editor to edit the input and run the necessary @@ -656,9 +661,9 @@ terminal window. This similarity is a design goal. While making it easy for beginners to start with LAMMPS, it is also the intention to simplify the transition to workflows like most experienced LAMMPS users do. -All features have been extensively exposed to hotkeys, so that there is -also appeal for experienced LAMMPS users, too, especially for -prototyping and testing simulations setups. +All features have been extensively exposed to keyboard shortcuts, so +that there is also appeal for experienced LAMMPS users for prototyping +and testing simulations setups. Features ^^^^^^^^ diff --git a/tools/lammps-gui/lammpsgui.cpp b/tools/lammps-gui/lammpsgui.cpp index afd9b99ed2..ba080dbec3 100644 --- a/tools/lammps-gui/lammpsgui.cpp +++ b/tools/lammps-gui/lammpsgui.cpp @@ -1243,9 +1243,12 @@ void LammpsGui::help() msg.setWindowTitle("LAMMPS-GUI Quick Help"); msg.setWindowIcon(QIcon(":/icons/lammps-icon-128x128.png")); msg.setText("
This is LAMMPS-GUI version " LAMMPS_GUI_VERSION "
"); - msg.setInformativeText("

LAMMPS GUI is a graphical text editor that is linked to the LAMMPS " + msg.setInformativeText("

LAMMPS GUI is a graphical text editor that is customized for " + "editing LAMMPS input files and linked to the LAMMPS " "library and thus can run LAMMPS directly using the contents of the " - "text buffer as input through the LAMMPS C-library interface.

" + "text buffer as input. It can retrieve and display information from " + "LAMMPS while it is running and display visualizations created " + "with the dump image command.

" "

The main window of the LAMMPS GUI is a text editor window with " "LAMMPS specific syntax highlighting. When typing Ctrl-Enter " "or clicking on 'Run LAMMMPS' in the 'Run' menu, LAMMPS will be run " @@ -1254,26 +1257,29 @@ void LammpsGui::help() "is displayed in a chart window. Both are updated regularly during the " "run, as is a progress bar in the main window. The running simulation " "can be stopped cleanly by typing Ctrl-/ or by clicking on " - "'Stop LAMMPS' in the 'Run' menu. After the simulation is finished " - "or stopped, an image of the simulated system can be shown in an image " + "'Stop LAMMPS' in the 'Run' menu. While LAMMPS is not running, " + "an image of the simulated system can be created and shown in an image " "viewer window by typing Ctrl-i or by clicking on 'View Image' " "in the 'Run' menu. Multiple image settings can be changed through the " - "buttons in the menu bar and the image will be re-renderd.

" + "buttons in the menu bar and the image will be re-renderd. In case " + "an input file contains a dump image command, LAMMPS GUI will load " + "the images as they are created and display them in a slide show.

" "

When opening a file, the editor will determine the directory " "where the input file resides and switch its current working directory " "to that same folder and thus enabling the run to read other files in " - "that folder, e.g. a data file .The GUI will show its current working " + "that folder, e.g. a data file. The GUI will show its current working " "directory in the status bar. In addition to using the menu, the " "editor window can also receive files as the first command line " "argument or via drag-n-drop from a graphical file manager or a " "desktop environment.

" - "

Almost all commands are accessible via hotkeys. Which those " - "hotkeys are, is typically shown next to their entries in the menus. " + "

Almost all commands are accessible via keyboard shortcuts. Which " + "those shortcuts are, is typically shown next to their entries in the " + "menus. " "In addition, the documentation for the command in the current line " "can be viewed by typing Ctrl-? or by choosing the respective " "entry in the context menu, available by right-clicking the mouse. " - "Log, chart, and image windows can be closed with Ctrl-W, the " - "main window with Ctrl-Q.

" + "Log, chart, slide show, and image windows can be closed with " + "Ctrl-W and the application terminated with Ctrl-Q.

" "

The 'About LAMMPS' dialog will show the LAMMPS version and the " "features included into the LAMMPS library linked to the LAMMPS GUI. " "A number of settings can be adjusted in the 'Preferences' dialog (in "