Unverified Commit b3a99f31 authored by Axel Kohlmeyer's avatar Axel Kohlmeyer
Browse files

add and document new "download" preset

parent 14957187
Loading
Loading
Loading
Loading
+17 −0
Original line number Diff line number Diff line
# preset that turns on packages with automatic downloads of sources of potentials
# compilation of libraries like Plumed or ScaFaCoS can take a considerable amount of time.

set(ALL_PACKAGES KIM LATTE MSCG VORONOI USER-PLUMED USER-SCAFACOS USER-SMD USER-MESONT)

foreach(PKG ${ALL_PACKAGES})
  set(PKG_${PKG} ON CACHE BOOL "" FORCE)
endforeach()

set(DOWNLOAD_KIM ON CACHE BOOL "" FORCE)
set(DOWNLOAD_LATTE ON CACHE BOOL "" FORCE)
set(DOWNLOAD_MSCG ON CACHE BOOL "" FORCE)
set(DOWNLOAD_VORO ON CACHE BOOL "" FORCE)
set(DOWNLOAD_EIGEN3 ON CACHE BOOL "" FORCE)
set(DOWNLOAD_PLUMED ON CACHE BOOL "" FORCE)
set(DOWNLOAD_SCAFACOS ON CACHE BOOL "" FORCE)
+17 −12
Original line number Diff line number Diff line
@@ -45,7 +45,8 @@ packages:
The mechanism for including packages is simple but different for CMake
versus make.

**CMake build**\ :
CMake build
^^^^^^^^^^^

.. code-block:: csh

@@ -72,7 +73,8 @@ once with CMake.
   invoke cmake.  CMake will give an error if that is not the case,
   indicating how you can un-install all packages in the src dir.

**Traditional make**\ :
Traditional make
^^^^^^^^^^^^^^^^

.. code-block:: bash

@@ -108,7 +110,8 @@ once with make.
   within the same command.  You can include or exclude multiple packages
   in a single make command, e.g. make yes-colloid no-manybody.

**CMake and make info**\ :
CMake and make info
^^^^^^^^^^^^^^^^^^^

Any package can be included or excluded in a LAMMPS build, independent
of all other packages.  However, some packages include files derived
@@ -132,7 +135,7 @@ src directory.

.. _cmake_presets:

**CMake shortcuts for installing many packages**\ :
CMake presets for installing many packages

Instead of specifying all the CMake options via the command-line,
CMake allows initializing its settings cache using script files.
@@ -150,6 +153,7 @@ one of them as a starting point and customize it to your needs.

    cmake -C ../cmake/presets/minimal.cmake  [OPTIONS] ../cmake  # enable just a few core packages
    cmake -C ../cmake/presets/most.cmake     [OPTIONS] ../cmake  # enable most packages
    cmake -C ../cmake/presets/download.cmake [OPTIONS] ../cmake  # enable packages which download sources or potential files
    cmake -C ../cmake/presets/nolib.cmake    [OPTIONS] ../cmake  # disable packages that do require extra libraries or tools
    cmake -C ../cmake/presets/clang.cmake    [OPTIONS] ../cmake  # change settings to use the Clang compilers by default
    cmake -C ../cmake/presets/intel.cmake    [OPTIONS] ../cmake  # change settings to use the Intel compilers by default
@@ -184,7 +188,8 @@ one of them as a starting point and customize it to your needs.

----------

**Make shortcuts for installing many packages**\ :
Make shortcuts for installing many packages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The following commands are useful for managing package source files
and their installation when building LAMMPS via traditional make.