diff --git a/doc/src/Howto_lammps_gui.rst b/doc/src/Howto_lammps_gui.rst index 5f48754ed5..b2d2ba754e 100644 --- a/doc/src/Howto_lammps_gui.rst +++ b/doc/src/Howto_lammps_gui.rst @@ -71,6 +71,46 @@ channels as for LAMMPS itself ` for that purpose. ----- +Installing Pre-compiled LAMMPS-GUI Packages +------------------------------------------- + +LAMMPS-GUI is available as pre-compiled binary packages for Linux +x86\_64, macOS 11 and later, and Windows 10 and later. Alternately, it +can be compiled from source. + +Windows 10 and later +^^^^^^^^^^^^^^^^^^^^ + +After downloading the ``LAMMPS-Win10-64bit-GUI-.exe`` installer +package, you need to execute it, and start the installation process. +Since those packages are currently unsigned, you have to enable "Developer Mode" +in the Windows System Settings to run the installer. + +MacOS 11 and later +^^^^^^^^^^^^^^^^^^ + +After downloading the ``LAMMPS-macOS-multiarch-GUI-.dmg`` +installer package, you need to double-click it and then, in the window +that opens, drag the app bundle as indicated into the "Applications" +folder. The follow the instructions in the "README.txt" file to +get access to the other included executables. + +Linux on x86\_64 +^^^^^^^^^^^^^^^^ + +After downloading and unpacking the +``LAMMPS-Linux-x86_64-GUI-.tar.gz`` package. You can switch +into the "LAMMPS_GUI" folder and execute "./lammps-gui" directly. + +Compiling from Source +^^^^^^^^^^^^^^^^^^^^^ + +There also are instructions for :ref:`compiling LAMMPS-GUI from source +code ` avilable elsewhere in the manual. +Compilation from source *requires* using CMake. + +----- + Starting LAMMPS-GUI ------------------- @@ -104,10 +144,7 @@ the ``File`` menu, the `Ctrl-O` (`Command-O` on macOS) keyboard shortcut or by drag-and-drop of a file from a graphical file manager into the editor window. If a file extension (e.g. ``.lmp``) has been registered with the graphical environment to launch LAMMPS-GUI, an existing input file can -be launched with LAMMPS-GUI through double clicking. For the pre-compiled -macOS and Windows packages, this is enabled, for Linux the bundled -``lammps-gui.desktop`` file and the ``lammps-input.xml`` file need to be -registered with the graphical desktop. +be launched with LAMMPS-GUI through double clicking. Only one file can be edited at a time, so opening a new file with a filled buffer closes that buffer. If the buffer has unsaved diff --git a/doc/src/Tools.rst b/doc/src/Tools.rst index 4505142459..060fd9f89d 100644 --- a/doc/src/Tools.rst +++ b/doc/src/Tools.rst @@ -484,23 +484,22 @@ are in the :doc:`Howto_lammps_gui` tutorial Howto page. Here are a few highlights of LAMMPS-GUI -- Text editor with syntax highlighting customized for LAMMPS -- Text editor features command completion for known commands and styles -- Text editor will switch working directory to folder of file in buffer -- Text editor will remember up to 5 recent files +- Text editor with line numbers and syntax highlighting customized for LAMMPS +- Text editor features command completion and auto-indentation for known commands and styles +- Text editor will switch its working directory to folder of file in buffer +- Many adjustable settings and preferences that are persistent including the 5 most recent files - Context specific LAMMPS command help via online documentation - LAMMPS is running in a concurrent thread, so the GUI remains responsive -- Support for most accelerator packages - Progress bar indicates how far a run command is completed -- LAMMPS can be started and stopped with a hotkey -- Screen output is captured in a Log Window -- Thermodynamic output is captured and displayed as line graph in a Chart Window +- LAMMPS can be started and stopped with a mouse click or a hotkey +- Screen output is captured in an *Output* Window +- Thermodynamic output is captured and displayed as line graph in a *Chart* Window - Indicator for currently executed command - Indicator for line that caused an error - Visualization of current state in Image Viewer (via calling :doc:`write_dump image `) - Capture of images created via :doc:`dump image ` in Slide show window -- Many adjustable settings and preferences that are persistent - Dialog to set variables, similar to the LAMMPS command line flag '-v' / '-var' +- Support for GPU, INTEL, KOKKOS/OpenMP, OPENMAP, and OPT and accelerator packages Parallelization ^^^^^^^^^^^^^^^ @@ -542,6 +541,8 @@ variable so the executables will be found automatically. The LAMMPS-GUI executable is called ``lammps-gui`` and either takes no arguments or attempts to load the first argument as LAMMPS input file. +.. _lammps_gui_compilation: + Compilation ^^^^^^^^^^^