diff --git a/doc/src/Tools.rst b/doc/src/Tools.rst index 060fd9f89d..0a9f7b941d 100644 --- a/doc/src/Tools.rst +++ b/doc/src/Tools.rst @@ -92,7 +92,7 @@ Miscellaneous tools * :ref:`emacs ` * :ref:`i-PI ` * :ref:`kate ` - * :ref:`LAMMPS GUI ` + * :ref:`LAMMPS-GUI ` * :ref:`LAMMPS magic patterns for file(1) ` * :ref:`Offline build tool ` * :ref:`singularity/apptainer ` @@ -524,6 +524,7 @@ The LAMMPS-GUI has been successfully compiled and tested on: - Fedora Linux 40 x86\_64 using GCC 14, Qt version 6.7 - Apple macOS 12 (Monterey) and macOS 13 (Ventura) with Xcode on arm64 and x86\_64, Qt version 5.15LTS - Windows 10 and 11 x86_64 with Visual Studio 2022 and Visual C++ 14.36, Qt version 5.15LTS +- Windows 10 and 11 x86_64 with Visual Studio 2022 and Visual C++ 14.40, Qt version 6.7 - Windows 10 and 11 x86_64 with MinGW / GCC 10.0 cross-compiler on Fedora 38, Qt version 5.15LTS .. _lammps_gui_install: @@ -532,12 +533,21 @@ The LAMMPS-GUI has been successfully compiled and tested on: Pre-compiled executables ^^^^^^^^^^^^^^^^^^^^^^^^ -Pre-compiled LAMMPS executable packages that include the GUI are currently -available from https://download.lammps.org/static or -https://github.com/lammps/lammps/releases. You can unpack the archives -(or mount the macOS disk image) and run the GUI directly in place. The -folder may also be moved around and added to the ``PATH`` environment -variable so the executables will be found automatically. The LAMMPS-GUI +Pre-compiled LAMMPS executable packages that include the GUI are +currently available from https://download.lammps.org/static or +https://github.com/lammps/lammps/releases. For Windows, you need to +download and then run the application installer. For macOS you download +and mount the disk image and then drag the application bundle to the +Applications folder. For Linux (x86_64) you currently have two +options: 1) you can download the tar.gz archive, unpack it and run the +GUI directly in place. The ``LAMMPS_GUI`` folder may also be moved +around and added to the ``PATH`` environment variable so the executables +will be found automatically. 2) you can download the `Flatpak file +`_ and then install it locally with the +*flatpak* command: ``flatpak install --user +LAMMPS-Linux-x86_64-GUI-.flatpak`` and run it with ``flatpak +run org.lammps.lammps-gui``. The flatpak version should also appear in +the applications menu of standard desktop environments. The LAMMPS-GUI executable is called ``lammps-gui`` and either takes no arguments or attempts to load the first argument as LAMMPS input file. @@ -1107,13 +1117,13 @@ necessary development headers and libraries are present. .. code-block:: bash - -D WITH_SWIG=on # to enable building any SWIG wrapper - -D BUILD_SWIG_JAVA=on # to enable building the Java wrapper - -D BUILD_SWIG_LUA=on # to enable building the Lua wrapper - -D BUILD_SWIG_PERL5=on # to enable building the Perl 5.x wrapper - -D BUILD_SWIG_PYTHON=on # to enable building the Python wrapper - -D BUILD_SWIG_RUBY=on # to enable building the Ruby wrapper - -D BUILD_SWIG_TCL=on # to enable building the Tcl wrapper + -D WITH_SWIG=on # to enable building any SWIG wrapper + -D BUILD_SWIG_JAVA=on # to enable building the Java wrapper + -D BUILD_SWIG_LUA=on # to enable building the Lua wrapper + -D BUILD_SWIG_PERL5=on # to enable building the Perl 5.x wrapper + -D BUILD_SWIG_PYTHON=on # to enable building the Python wrapper + -D BUILD_SWIG_RUBY=on # to enable building the Ruby wrapper + -D BUILD_SWIG_TCL=on # to enable building the Tcl wrapper Manual building allows a little more flexibility. E.g. one can choose diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index 002e861dc7..5406c3ac79 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -1186,6 +1186,7 @@ flaglog flagN flagVF flang +flatpak fld floralwhite Florez