add emacs local variable tweaks and add some missing docstrings

This commit is contained in:
Axel Kohlmeyer
2025-06-23 16:51:33 -04:00
parent bfa19f678d
commit 249c6d6de9
7 changed files with 37 additions and 1 deletions

View File

@ -52,3 +52,8 @@ def get_version_number():
return t.tm_year*10000 + t.tm_mon*100 + t.tm_mday return t.tm_year*10000 + t.tm_mon*100 + t.tm_mday
__version__ = get_version_number() __version__ = get_version_number()
# Local Variables:
# fill-column: 100
# python-indent-offset: 2
# End:

View File

@ -65,3 +65,8 @@ def get_ctypes_int(size):
if size == 8: if size == 8:
return c_int64 return c_int64
return c_int return c_int
# Local Variables:
# fill-column: 100
# python-indent-offset: 2
# End:

View File

@ -37,6 +37,7 @@ from lammps.data import NeighList
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
class MPIAbortException(Exception): class MPIAbortException(Exception):
"""Exception to use when LAMMPS wants to call MPI_Abort()"""
def __init__(self, message): def __init__(self, message):
self.message = message self.message = message
@ -60,6 +61,7 @@ class ExceptionCheck:
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
class command_wrapper: class command_wrapper:
"""Wrapper class to enable using 'lmp.xxx("args")' instead of 'lmp.command("xxx args")'"""
def __init__(self, lmp): def __init__(self, lmp):
self.lmp = lmp self.lmp = lmp
self.auto_flush = False self.auto_flush = False
@ -1625,12 +1627,14 @@ class lammps:
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
def clearstep_compute(self): def clearstep_compute(self):
"""Call 'lammps_clearstep_compute()' from Python"""
with ExceptionCheck(self): with ExceptionCheck(self):
return self.lib.lammps_clearstep_compute(self.lmp) return self.lib.lammps_clearstep_compute(self.lmp)
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
def addstep_compute(self, nextstep): def addstep_compute(self, nextstep):
"""Call 'lammps_addstep_compute()' from Python"""
with ExceptionCheck(self): with ExceptionCheck(self):
nextstep = self.c_bigint(nextstep) nextstep = self.c_bigint(nextstep)
return self.lib.lammps_addstep_compute(self.lmp, byref(nextstep)) return self.lib.lammps_addstep_compute(self.lmp, byref(nextstep))
@ -1638,6 +1642,7 @@ class lammps:
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
def addstep_compute_all(self, nextstep): def addstep_compute_all(self, nextstep):
"""Call 'lammps_addstep_compute_all()' from Python"""
with ExceptionCheck(self): with ExceptionCheck(self):
nextstep = self.c_bigint(nextstep) nextstep = self.c_bigint(nextstep)
return self.lib.lammps_addstep_compute_all(self.lmp, byref(nextstep)) return self.lib.lammps_addstep_compute_all(self.lmp, byref(nextstep))
@ -2894,5 +2899,6 @@ class lammps:
return idx return idx
# Local Variables: # Local Variables:
# fill-column: 80 # fill-column: 100
# python-indent-offset: 2
# End: # End:

View File

@ -91,3 +91,8 @@ class NeighList:
return numneigh, neighbors return numneigh, neighbors
return -1, None return -1, None
# Local Variables:
# fill-column: 100
# python-indent-offset: 2
# End:

View File

@ -231,3 +231,8 @@ class AvgChunkFile:
self.timesteps.append(timestep) self.timesteps.append(timestep)
self.total_count.append(total_count) self.total_count.append(total_count)
# Local Variables:
# fill-column: 100
# python-indent-offset: 2
# End:

View File

@ -526,3 +526,8 @@ class NumPyNeighList(NeighList):
if idx == iatom: if idx == iatom:
return neighbors return neighbors
return None return None
# Local Variables:
# fill-column: 100
# python-indent-offset: 2
# End:

View File

@ -1015,3 +1015,8 @@ class IPyLammps(PyLammps):
""" """
from IPython.display import HTML from IPython.display import HTML
return HTML("<video controls><source src=\"" + filename + "\"></video>") return HTML("<video controls><source src=\"" + filename + "\"></video>")
# Local Variables:
# fill-column: 100
# python-indent-offset: 2
# End: