ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update quick help and TODO list

Browse Source
This commit is contained in:
Axel Kohlmeyer
2023-08-15 05:35:34 -04:00
parent 263db3d13c
commit 62547ccde5
3 changed files with 41 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
tools/lammps-gui/lammpsgui.cpp
View File

@ -880,38 +880,44 @@ void LammpsGui::help()
QMessageBox msg;
msg.setWindowTitle("LAMMPS-GUI Quick Help");
msg.setText("<div>This is LAMMPS-GUI version " LAMMPS_GUI_VERSION "</div>");
msg.setInformativeText("<b>Overview</b>"
"<div align=\"justify\">LAMMPS GUI is a graphical text editor that is "
"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. This makes it convenient to use for beginners and during "
"tutorials</div><br><br>"
"<b>Features</b>"
"<div align=\"justify\">The main window of the LAMMPS GUI is a text "
"editor window with syntax highlighting. The output of a LAMMPS run is "
"captured and displayed in a log window. The log window is updated "
"regularly during the run, as is a progress bar in the main window. "
"After the simulation is finished, an image of the simulated system "
"can be created and shown (and saved) in image viewer window. Ongoing "
"runs can be stopped at the next run iteration.</div><br>"
"<div align=\"justify\">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. Many LAMMPS inputs contain "
"commands that read other files, typically from the folder as the "
"input file. The GUI will show its current working directory. "
"In addition to using the menu, the editor window also receive files "
"as the first command line argument or via drag-n-drop from a "
"graphical file manager GUI or a desktop environment.</div><br>"
"<div align=\"justify\">Almost all commands are accessible via hotkeys. "
"Which those hotkeys are, is shown next to the entries in the menus. "
"Log and image viewer windows can be closed with CTRL-W (or Command-W "
"on macOS).</div><br>"
"<div align=\"justify\">The 'About LAMMPS' dialog will show the "
"LAMMPS version and the features included into the LAMMPS library "
"linked to the LAMMPS GUI.<br><br>"
"Due to its nature as a graphical application, it is <b>not</b> "
"possible to use the LAMMPS GUI in parallel with MPI, but OpenMP "
"multi-threading is available.</div>");
msg.setInformativeText("<p>LAMMPS GUI is a graphical text editor that is 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. </p>"
"<p>The main window of the LAMMPS GUI is a text editor window with "
"LAMMPS specific syntax highlighting. When typing <b>Ctrl-Enter</b> "
"or clicking on 'Run LAMMMPS' in the 'Run' menu, LAMMPS will be run "
"with the contents of editor buffer as input. The output of the LAMMPS "
"run is captured and displayed in a log window. The thermodynamic data "
"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 <b>Ctrl-/</b> 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 "
"viewer window by typing <b>Ctrl-i</b> 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.</p>"
"<p>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 "
"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.</p>"
"<p>Almost all commands are accessible via hotkeys. Which those "
"hotkeys 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 <b>Ctrl-?</b> 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 <b>Ctrl-W</b>, the "
"main window with <b>Ctrl-Q</b>.</p>"
"<p>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 "
"the 'Edit' menu or from <b>Ctrl-P</b>) which includes selecting "
"accelerator packages and number of OpenMP threads. Due to its nature "
"as a graphical application, it is <b>not</b> possible to use the "
"LAMMPS GUI in parallel with MPI.</p>");
msg.setIconPixmap(QPixmap(":/lammps-icon-128x128.png").scaled(64, 64));
msg.setStandardButtons(QMessageBox::Close);
msg.exec();