diff --git a/doc/src/Install.rst b/doc/src/Install.rst index 04e5333fea..b327dfcbff 100644 --- a/doc/src/Install.rst +++ b/doc/src/Install.rst @@ -18,6 +18,8 @@ you **must** build LAMMPS from the source code. developers have no control over their choices of how they configure and build their packages and when they update them. +---- + .. toctree:: :maxdepth: 1 @@ -29,38 +31,40 @@ you **must** build LAMMPS from the source code. Install_tarball Install_git +---- + These are the files and sub-directories in the LAMMPS distribution: -+------------+-------------------------------------------+ -| README | Short description of the LAMMPS package | -+------------+-------------------------------------------+ -| LICENSE | GNU General Public License (GPL) | -+------------+-------------------------------------------+ -| SECURITY.md| Security Policy for the LAMMPS package | -+------------+-------------------------------------------+ -| bench | benchmark problems | -+------------+-------------------------------------------+ -| cmake | CMake build files | -+------------+-------------------------------------------+ -| doc | documentation | -+------------+-------------------------------------------+ -| examples | simple test problems | -+------------+-------------------------------------------+ -| fortran | Fortran wrapper for LAMMPS | -+------------+-------------------------------------------+ -| lib | additional provided or external libraries | -+------------+-------------------------------------------+ -| potentials | interatomic potential files | -+------------+-------------------------------------------+ -| python | Python wrappers for LAMMPS | -+------------+-------------------------------------------+ -| src | source files | -+------------+-------------------------------------------+ -| tools | pre- and post-processing tools | -+------------+-------------------------------------------+ -| unittest | sources and inputs for testing LAMMPS | -+------------+-------------------------------------------+ ++------------+---------------------------------------------+ +| README | Short description of the LAMMPS package | ++------------+---------------------------------------------+ +| LICENSE | GNU General Public License (GPL) | ++------------+---------------------------------------------+ +| SECURITY.md| Security policy for the LAMMPS package | ++------------+---------------------------------------------+ +| bench | benchmark inputs | ++------------+---------------------------------------------+ +| cmake | CMake build files | ++------------+---------------------------------------------+ +| doc | documentation and tools to build the manual | ++------------+---------------------------------------------+ +| examples | example input files | ++------------+---------------------------------------------+ +| fortran | Fortran module for LAMMPS library interface | ++------------+---------------------------------------------+ +| lib | additional provided or external libraries | ++------------+---------------------------------------------+ +| potentials | selected interatomic potential files | ++------------+---------------------------------------------+ +| python | Python module for LAMMPS library interface | ++------------+---------------------------------------------+ +| src | LAMMPS source files | ++------------+---------------------------------------------+ +| tools | pre- and post-processing tools | ++------------+---------------------------------------------+ +| unittest | source code and inputs for testing LAMMPS | ++------------+---------------------------------------------+ -You will have all of these if you download source. You will only have -some of them if you download executables, as explained on the pages -listed above. +You will have all of these if you downloaded the LAMMPS source code. +You will have only some of them if you downloaded executables, as +explained on the pages listed above.