diff --git a/doc/Section_howto.html b/doc/Section_howto.html index 627665a6bf..b92c8ae842 100644 --- a/doc/Section_howto.html +++ b/doc/Section_howto.html @@ -582,6 +582,24 @@ Again, the run command has options that allow it to be invoked with minimal overhead (no setup or clean-up) if you wish to do multiple short runs, driven by another program.

+

Examples of driver codes that call LAMMPS as a library are included in +the "couple" directory of the LAMMPS distribution; see couple/README +for more details: +

+ + + + +

This section of the documentation describes how to build LAMMPS as a library. Once this is done, you can interface with LAMMPS either via C++, C, or Fortran (or any other diff --git a/doc/Section_howto.txt b/doc/Section_howto.txt index 1d7dab1514..4cca04165c 100644 --- a/doc/Section_howto.txt +++ b/doc/Section_howto.txt @@ -578,6 +578,23 @@ Again, the "run"_run.html command has options that allow it to be invoked with minimal overhead (no setup or clean-up) if you wish to do multiple short runs, driven by another program. +Examples of driver codes that call LAMMPS as a library are included in +the "couple" directory of the LAMMPS distribution; see couple/README +for more details: + +simple: simple driver programs in C++ and C which invoke LAMMPS as a +library :ulb,l + +lammps_quest: coupling of LAMMPS and "Quest"_quest, to run classical +MD with quantum forces calculated by a density functional code :l + +lammps_spparks: coupling of LAMMPS and "SPPARKS"_spparks, to couple +a kinetic Monte Carlo model for grain growth using MD to calculate +strain induced across grain boundaries :l,ule + +:link(quest,http://dft.sandia.gov/Quest) +:link(spparks,http://www.sandia.gov/~sjplimp/spparks.html) + "This section"_Section_start.html#2_4 of the documentation describes how to build LAMMPS as a library. Once this is done, you can interface with LAMMPS either via C++, C, or Fortran (or any other diff --git a/doc/Section_start.html b/doc/Section_start.html index f4d4d0d5d9..f74e1bce88 100644 --- a/doc/Section_start.html +++ b/doc/Section_start.html @@ -42,6 +42,7 @@ sub-directories: README text file LICENSE the GNU General Public License (GPL) bench benchmark problems +couple code coupling examples, using LAMMPS as a library doc documentation examples simple test problems potentials embedded atom method (EAM) potential files diff --git a/doc/Section_start.txt b/doc/Section_start.txt index bf0f99001b..2904f9f689 100644 --- a/doc/Section_start.txt +++ b/doc/Section_start.txt @@ -38,6 +38,7 @@ sub-directories: README: text file LICENSE: the GNU General Public License (GPL) bench: benchmark problems +couple: code coupling examples, using LAMMPS as a library doc: documentation examples: simple test problems potentials: embedded atom method (EAM) potential files