From 3103fe85f6c39672dae0d092c2ca5e9771810d6c Mon Sep 17 00:00:00 2001 From: Richard Berger Date: Tue, 15 Dec 2020 19:16:29 -0500 Subject: [PATCH] Update Python_module.rst --- doc/src/Python_module.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/src/Python_module.rst b/doc/src/Python_module.rst index 04bc3f2c5b..8b4fbe1c2e 100644 --- a/doc/src/Python_module.rst +++ b/doc/src/Python_module.rst @@ -3,12 +3,12 @@ The ``lammps`` Python module .. py:module:: lammps -The LAMMPS Python interface is implemented as a module called -:py:mod:`lammps` in the ``lammps.py`` file in the ``python`` folder of -the LAMMPS source code distribution. After compilation of LAMMPS, the -module can be installed into a Python system folder or a user folder -with ``make install-python``. Components of the module can then loaded -into a Python session with the ``import`` command. +The LAMMPS Python interface is implemented as a module called :py:mod:`lammps` +which is defined in the ``lammps`` package in the ``python`` folder of the +LAMMPS source code distribution. After compilation of LAMMPS, the module can +be installed into a Python system folder or a user folder with ``make +install-python``. Components of the module can then loaded into a Python +session with the ``import`` command. There are multiple Python interface classes in the :py:mod:`lammps` module: @@ -44,7 +44,7 @@ functions. Below is a detailed documentation of the API. .. autoclass:: lammps.lammps :members: -.. autoclass:: lammps.numpy_wrapper +.. autoclass:: lammps.numpy::numpy_wrapper :members: ---------- @@ -117,8 +117,8 @@ Style Constants to request from computes or fixes. See :cpp:enum:`_LMP_STYLE_CONST` for the equivalent constants in the C library interface. Used in :py:func:`lammps.extract_compute`, :py:func:`lammps.extract_fix`, and their NumPy variants - :py:func:`lammps.numpy.extract_compute() ` and - :py:func:`lammps.numpy.extract_fix() `. + :py:func:`lammps.numpy.extract_compute() ` and + :py:func:`lammps.numpy.extract_fix() `. .. _py_type_constants: @@ -132,8 +132,8 @@ Type Constants to request from computes or fixes. See :cpp:enum:`_LMP_TYPE_CONST` for the equivalent constants in the C library interface. Used in :py:func:`lammps.extract_compute`, :py:func:`lammps.extract_fix`, and their NumPy variants - :py:func:`lammps.numpy.extract_compute() ` and - :py:func:`lammps.numpy.extract_fix() `. + :py:func:`lammps.numpy.extract_compute() ` and + :py:func:`lammps.numpy.extract_fix() `. .. _py_vartype_constants: @@ -153,6 +153,6 @@ Classes representing internal objects :members: :no-undoc-members: -.. autoclass:: lammps.NumPyNeighList +.. autoclass:: lammps.numpy::NumPyNeighList :members: :no-undoc-members: