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

5
tools/lammps-gui/TODO.md
View File

@ -2,7 +2,6 @@ LAMMPS-GUI TODO list:
# Short term goals # Short term goals
- write LAMMPS GUI Howto showing/explaining options -> simplify docs and readme
- rewrite syntax highlighting to be line oriented instead of word oriented. - rewrite syntax highlighting to be line oriented instead of word oriented.
handle first part of line based on regular expressions, then advance and only highlight strings and numbers. handle first part of line based on regular expressions, then advance and only highlight strings and numbers.
handle "&" continuation and multiline strings with """ like C style comments in Qt docs example handle "&" continuation and multiline strings with """ like C style comments in Qt docs example
@ -11,7 +10,6 @@ LAMMPS-GUI TODO list:
- need to handle "label" and "jump" commands from within ? - need to handle "label" and "jump" commands from within ?
- switch processing of input to line based commands or? - switch processing of input to line based commands or?
- switch input file editor to read-only while loop is running - switch input file editor to read-only while loop is running
- embed all icons/graphics
# Long term ideas # Long term ideas
- add feature to LAMMPS (to the LAMMPS class) to store current file name and line number, update while reading/parsing - add feature to LAMMPS (to the LAMMPS class) to store current file name and line number, update while reading/parsing
@ -25,4 +23,5 @@ LAMMPS-GUI TODO list:
- support single stepping, i.e. process input line by line (need to detect continuation chars!) with highlighting active line(s) - support single stepping, i.e. process input line by line (need to detect continuation chars!) with highlighting active line(s)
- have command text input file in/above status bar where individual commands can be tested. have insert button to copy line into file at the current point - have command text input file in/above status bar where individual commands can be tested. have insert button to copy line into file at the current point
- support text completion as done with lammps-shell - support text completion as done with lammps-shell
- add a "python" mode, where instead of launching LAMMPS, python is loaded that the LAMMPS python module is made available. - add a "python" mode, where instead of launching LAMMPS, python is loaded where the LAMMPS python module is made available.
- support multiple tabs and multiple LAMMPS instances?

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

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

2
tools/lammps-gui/lammpsgui.ui
View File

@ -246,7 +246,7 @@
<iconset theme=":/help-about.png"/> <iconset theme=":/help-about.png"/>
</property> </property>
<property name="text"> <property name="text">
<string>&amp;About LAMMPS-GUI</string> <string>&amp;About LAMMPS</string>
</property> </property>
<property name="shortcut"> <property name="shortcut">
<string>Ctrl+Shift+A</string> <string>Ctrl+Shift+A</string>