diff --git a/doc/src/Python_head.rst b/doc/src/Python_head.rst index 6952215188..e78e727a10 100644 --- a/doc/src/Python_head.rst +++ b/doc/src/Python_head.rst @@ -13,6 +13,7 @@ used together. Python_usage Python_call Python_config + Python_neighbor Python_module Python_examples Python_error diff --git a/doc/src/Python_neighbor.rst b/doc/src/Python_neighbor.rst new file mode 100644 index 0000000000..2e8f84050c --- /dev/null +++ b/doc/src/Python_neighbor.rst @@ -0,0 +1,18 @@ +Accessing LAMMPS Neighbor lists +******************************* + +**Methods:** + +* :py:meth:`lammps.get_neighlist() `: Get neighbor list for given index +* :py:meth:`lammps.get_neighlist_size()`: Get number of elements in neighbor list +* :py:meth:`lammps.get_neighlist_element_neighbors()`: Get element in neighbor list and its neighbors + +* :py:meth:`lammps.find_pair_neighlist() `: Find neighbor list of pair style +* :py:meth:`lammps.find_fix_neighlist() `: Find neighbor list of pair style +* :py:meth:`lammps.find_compute_neighlist() `: Find neighbor list of pair style + + +**NumPy Methods:** + +* :py:meth:`lammps.numpy.get_neighlist() `: Get neighbor list for given index, which uses NumPy arrays for its element neighbor arrays +* :py:meth:`lammps.numpy.get_neighlist_element_neighbors() `: Get element in neighbor list and its neighbors (as numpy array)