From 269690b771882997a3bcc462526dcfcc5f057eea Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Tue, 27 Jul 2021 18:21:22 -0400 Subject: [PATCH] document hard package dependencies --- doc/src/Packages_details.rst | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/doc/src/Packages_details.rst b/doc/src/Packages_details.rst index 28ae032d34..b4e50fad75 100644 --- a/doc/src/Packages_details.rst +++ b/doc/src/Packages_details.rst @@ -189,6 +189,7 @@ atomic information to continuum fields. **Install:** This package has :ref:`specific installation instructions ` on the :doc:`Build extras ` page. +The ATC package requires that also the `MANYBODY `_ package is installed. **Supporting info:** @@ -518,6 +519,11 @@ compute for simulating systems using boundary element solvers for computing the induced charges at the interface between two media with different dielectric constants. +**Install:** + +To use this package, also the :ref:`KSPACE ` and +:ref:`EXTRA-PAIR ` packages need to be installed. + **Author:** Trung Nguyen and Monica Olvera de la Cruz (Northwestern U) **Supporting info:** @@ -1210,6 +1216,10 @@ can be used to model MD particles influenced by hydrodynamic forces. **Authors:** Frances Mackay and Colin Denniston (University of Western Ontario). +**Install:** + +The LATBOLTZ package requires that LAMMPS is build in :ref:`MPI parallel mode `. + **Supporting info:** * src/LATBOLTZ: filenames -> commands @@ -1603,9 +1613,9 @@ A general interface for machine-learning interatomic potentials, including PyTor **Install:** -To use this package, also the :ref:`ML-SNAP package ` package needs +To use this package, also the :ref:`ML-SNAP ` package needs to be installed. To make the *mliappy* model available, also the -:ref:`PYTHON package ` package needs to be installed, the version +:ref:`PYTHON ` package needs to be installed, the version of Python must be 3.6 or later, and the `cython `_ software must be installed. @@ -1870,6 +1880,10 @@ MPIIO library. It adds :doc:`dump styles ` with a "mpiio" in their style name. Restart files with an ".mpiio" suffix are also written and read in parallel. +**Install:** + +The MPIIO package requires that LAMMPS is build in :ref:`MPI parallel mode `. + **Supporting info:** * src/MPIIO: filenames -> commands @@ -2103,6 +2117,12 @@ And a :doc:`dynamical_matrix ` as well as a :doc:`third_order ` command to compute the dynamical matrix and third order tensor from finite differences. +**Install:** + +The PHONON package requires that also the `KSPACE `_ +package is installed. + + **Authors:** Ling-Ti Kong (Shanghai Jiao Tong University) for "fix phonon" and Charlie Sievers (UC Davis) for "dynamical_matrix" and "third_order" @@ -2486,6 +2506,7 @@ the Forschungszentrum Juelich. **Install:** This package has :ref:`specific installation instructions ` on the :doc:`Build extras ` page. +The SCAFACOS package requires that LAMMPS is build in :ref:`MPI parallel mode `. **Supporting info:**