diff --git a/doc/src/Build_make.rst b/doc/src/Build_make.rst index a6caa7cd58..ebd1790e11 100644 --- a/doc/src/Build_make.rst +++ b/doc/src/Build_make.rst @@ -9,10 +9,12 @@ build with a number of global compilation options and features. Those makefiles are written for and tested with GNU make and may not be compatible with other make programs. In most cases, if the "make" -program is not GNU make, then it will be installed as "gmake". If -GNU make or a compatible make is not available, you may have to first -install it. These makefiles and the scripts they are calling expect -a few additional tools to be available and functioning. +program is not GNU make, then there will be a GNU make program +available under the name "gmake". If GNU make or a compatible make is +not available, you may have to first install it or switch to building +with :doc:`CMake `. The makefiles of the traditional +make based build process and the scripts they are calling expect a few +additional tools to be available and functioning. * a Bourne shell compatible "Unix" shell program (often this is bash) * a few shell utilities: ls, mv, ln, rm, grep, sed, tr, cat, touch, diff, dirname @@ -21,15 +23,16 @@ a few additional tools to be available and functioning. To include LAMMPS packages (i.e. optional commands and styles) you must enable them first, as discussed on the :doc:`Build package ` doc page. If a packages requires (provided or -external) libraries, you must build those libraries before building -LAMMPS. Building :doc:`LAMMPS with CMake ` can automate -much of this for many types of machines, especially workstations, -desktops and laptops, so we suggest you try it first. +external) libraries, you must configure and build those libraries +**before** building LAMMPS itself and especially **before** enabling +such a package with "make yes-". Building :doc:`LAMMPS +with CMake ` can automate much of this for many types of +machines, especially workstations, desktops, and laptops, so we suggest +you try it first when building LAMMPS in those cases. The commands below perform a default LAMMPS build, producing the LAMMPS executable lmp\_serial and lmp\_mpi in lammps/src: - .. code-block:: bash cd lammps/src @@ -64,10 +67,11 @@ re-compiled. ---------- -The lammps/src/MAKE tree contains all the Makefile.machine files -included in the LAMMPS distribution. Typing "make machine" uses -Makefile.machine. Thus the "make serial" or "make mpi" lines above -use Makefile.serial and Makefile.mpi. Others are in these dirs: +The lammps/src/MAKE tree contains the Makefile.machine files included +in the LAMMPS distribution. Typing "make machine" uses +*Makefile.machine*\ . Thus the "make serial" or "make mpi" lines above +use Makefile.serial and Makefile.mpi, respectively. Other makefiles +are in these directories: .. parsed-literal:: @@ -78,7 +82,7 @@ use Makefile.serial and Makefile.mpi. Others are in these dirs: Typing "make" lists all the available Makefile.machine files. A file with the same name can appear in multiple folders (not a good idea). -The order the dirs are searched is as follows: src/MAKE/MINE, +The order the directories are searched is as follows: src/MAKE/MINE, src/MAKE, src/MAKE/OPTIONS, src/MAKE/MACHINES. This gives preference to a customized file you put in src/MAKE/MINE. diff --git a/doc/src/Examples.rst b/doc/src/Examples.rst index d2785378da..243ffdfd93 100644 --- a/doc/src/Examples.rst +++ b/doc/src/Examples.rst @@ -29,11 +29,12 @@ be quickly post-processed into a movie using commands described on the Animations of many of the examples can be viewed on the Movies section of the `LAMMPS web site `_. -There are two kinds of sub-directories in the examples dir. Lowercase -dirs contain one or a few simple, quick-to-run problems. Uppercase -dirs contain up to several complex scripts that illustrate a -particular kind of simulation method or model. Some of these run for -longer times, e.g. to measure a particular quantity. +There are two kinds of sub-directories in the examples folder. Lower +case named directories contain one or a few simple, quick-to-run +problems. Upper case named directories contain up to several complex +scripts that illustrate a particular kind of simulation method or +model. Some of these run for longer times, e.g. to measure a +particular quantity. Lists of both kinds of directories are given below. diff --git a/doc/src/Speed_bench.rst b/doc/src/Speed_bench.rst index 711d274052..c577bc426a 100644 --- a/doc/src/Speed_bench.rst +++ b/doc/src/Speed_bench.rst @@ -36,9 +36,9 @@ scalability on your machine. The bench directory includes a few log.\* files that show performance of these 5 problems on 1 or 4 cores of Linux desktop. The bench/FERMI -and bench/KEPLER dirs have input files and scripts and instructions +and bench/KEPLER directories have input files and scripts and instructions for running the same (or similar) problems using OpenMP or GPU or Xeon -Phi acceleration options. See the README files in those dirs and the +Phi acceleration options. See the README files in those directories and the :doc:`Speed packages ` doc pages for instructions on how to build LAMMPS and run on that kind of hardware. diff --git a/doc/src/Speed_packages.rst b/doc/src/Speed_packages.rst index 039b8c51a0..124e623215 100644 --- a/doc/src/Speed_packages.rst +++ b/doc/src/Speed_packages.rst @@ -146,7 +146,7 @@ details. Likewise, the bench directory has FERMI and KEPLER and PHI sub-directories with Make.py commands and input scripts for using all the accelerator packages on various machines. See the README files in -those dirs. +those directories. As mentioned above, the `Benchmark page `_ of the LAMMPS web site gives performance results for the various accelerator packages for several diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index e8c7223f70..32c5eb47b1 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -614,7 +614,6 @@ dipolar dir Direc dirname -dirs discoverable discretization discretized