diff --git a/doc/src/Classes.rst b/doc/src/Classes.rst index 78e1dabcd1..4b50eef7b2 100644 --- a/doc/src/Classes.rst +++ b/doc/src/Classes.rst @@ -5,7 +5,7 @@ LAMMPS is designed to be used as a C++ class library where one can set up and drive a simulation through creating a class instance and then calling some abstract operations or commands on that class or its member class instances. These are interfaced to the :doc:`C library API -`, which providing an additional level of abstraction +`, which providing an additional level of abstraction simplification for common operations. The C API is also the basis for calling LAMMPS from Python or Fortran. @@ -33,6 +33,6 @@ some selected examples for derived classes of specific models. :caption: Individual Base Classes :name: lammpsbase - pg_lammps - pg_atom - pg_input + Classes_lammps + Classes_atom + Classes_input diff --git a/doc/src/Howto_couple.rst b/doc/src/Howto_couple.rst index 2eadbb522e..36ba2a526e 100644 --- a/doc/src/Howto_couple.rst +++ b/doc/src/Howto_couple.rst @@ -54,7 +54,7 @@ context of your application. invoked with minimal overhead (no setup or clean-up) if you wish to do multiple short runs, driven by another program. Details about using the library interface are given in the :doc:`library API - ` documentation. + ` documentation. .. spacer diff --git a/doc/src/Howto_library.rst b/doc/src/Howto_library.rst index afa8dde941..36d6626c59 100644 --- a/doc/src/Howto_library.rst +++ b/doc/src/Howto_library.rst @@ -20,8 +20,8 @@ Creating a LAMMPS instance can be done by using C++ code directly or through a C-style interface library to LAMMPS that is provided in the files ``src/library.cpp`` and ``library.h``. This :ref:`C language API `, can be used from C and C++, -and is also the basis for the :doc:`Python ` and -:doc:`Fortran ` interfaces or wrappers included in the +and is also the basis for the :doc:`Python ` and +:doc:`Fortran ` interfaces or wrappers included in the LAMMPS source code. The ``examples/COUPLE`` and ``python/examples`` directories contain some @@ -33,5 +33,5 @@ LAMMPS. A detailed documentation of the available APIs and examples of how to use them can be found in the :doc:`Programmer Documentation -` section of this manual. +` section of this manual. diff --git a/doc/src/Library.rst b/doc/src/Library.rst index 7d843e0745..42c554467e 100644 --- a/doc/src/Library.rst +++ b/doc/src/Library.rst @@ -53,7 +53,7 @@ LAMMPS C Library API The C library interface is most commonly used path to manage LAMMPS instances from a compiled code and it is the basis for the :doc:`Python -` and :doc:`Fortran ` modules. Almost all +` and :doc:`Fortran ` modules. Almost all functions of the C language API require an argument containing a "handle" in the form of a ``void *`` type variable, which points to the location of a LAMMPS class instance. diff --git a/doc/src/Python_module.rst b/doc/src/Python_module.rst index 37cfb2c6db..e9a48dd797 100644 --- a/doc/src/Python_module.rst +++ b/doc/src/Python_module.rst @@ -204,7 +204,7 @@ to "compute" what the next LAMMPS command should be. .. tab:: lammps API Same as in the equivalent - :doc:`C library functions `, commands can be read from a file, a + :doc:`C library functions `, commands can be read from a file, a single string, a list of strings and a block of commands in a single multi-line string. They are processed under the same boundary conditions as the C library counterparts. The example below demonstrates the use