Package schrodinger :: Module surface
[hide private]
[frames] | no frames]

Module surface

Pythonic wrappings for mmsurf surfaces

Classes [hide private]
  Style
Surface representation styles.
  ColorFrom
Values for surface color sources.
  StrEnum
An enum class where all values are strings.
  ColorBy
Values for surface color schemes.
  Color
Mmvol colors.
  MolSurfType
Types of molecular surfaces.
  Surface
A Pythonic wrapping for mmsurf surfaces that are not associated with a project entry.
  ProjectSurface
A Pythonic wrapping for mmsurf surfaces retrieved from a project.
  SurfaceDict
A dictionary of {surface name: ProjectSurface object} for the specified project row.
Functions [hide private]
 
mmvol_func(func, *args, **kwargs)
A decorator for functions that require mmvol initialization.
 
_requires_update(func, self, *args, **kwargs)
A decorator for Surface methods that update the visual representation of the surface.
Variables [hide private]
  DELAYED_MAESTRO_LOAD = object()
  maestro = object()
Function Details [hide private]

mmvol_func(func, *args, **kwargs)

 

A decorator for functions that require mmvol initialization.

Decorators:
  • @decorator.decorator

_requires_update(func, self, *args, **kwargs)

 

A decorator for Surface methods that update the visual representation of the surface. This decorator, tells Maestro to update the workspace surface representation and ensures that we only force one update even if a decorated method calls another decorated method.

Decorators:
  • @decorator.decorator