schrodinger.maestro_utils.surface_manager.commands module

class schrodinger.maestro_utils.surface_manager.commands.MaestroCommand

Bases: Enum

Enum for Maestro commands.

SURFACE_DISPLAY = 'surfacedisplay'
SURFACE_RENAME = 'surfacerename'
SURFACE_DELETE = 'surfacedelete'
SURFACE_SET_COMMENT = 'surfacesetcomment'
SHOW_PANEL = 'showpanel'
VIS_EXPORT = 'visexport'
SURFACE_DUPLICATE = 'surfaceduplicate'
SURFACE_SPLIT_PAIR = 'surfacesplitpair'
VOLUME_DISPLAY = 'volumedisplay'
SURFACE_STYLE = 'surfacestyle'
SURFACE_TRANSPARENCY = 'surfacetransparency'
SURFACE_TRANSPARENCY_BACK = 'surfacetransparencyback'
schrodinger.maestro_utils.surface_manager.commands.execute_maestro_command(command_str: str)

Execute a maestro command string.

Parameters:

command_str – The command string to execute

schrodinger.maestro_utils.surface_manager.commands.update_surface_display(entry_id: int, display: bool, surface_name: str)

Execute Maestro Command to update display of surfaces.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • display – Boolean indicating whether to display the surface.

  • surface_name – Name of the surface.

schrodinger.maestro_utils.surface_manager.commands.rename_surface(entry_id: int, new_name: str, old_name: str)

Execute Maestro Command to rename a surface.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • new_name – New name for the surface.

  • old_name – Old name of the surface.

schrodinger.maestro_utils.surface_manager.commands.delete_surface(entry_id: int, surface_name: str)

Execute Maestro Command to delete a surface.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • surface_name – Name of the surface.

schrodinger.maestro_utils.surface_manager.commands.set_surface_comment(entry_id: int, surface_name: str, comment: str)

Execute Maestro Command to set a comment for a surface.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • surface_name – Name of the surface.

  • comment – Comment to set for the surface.

schrodinger.maestro_utils.surface_manager.commands.show_panel(panel_name: str)

Show a specific panel in Maestro.

Parameters:

panel_name – Name of the panel to show.

schrodinger.maestro_utils.surface_manager.commands.export_volume_to_map(entry_id: int, surface_name: str, file_path: str, volume_name: str, surface_type: str, surface_comment: str, format: str = None)

Export the volume of a surface to a map file.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • surface_name – Name of the surface.

  • file_path – Path to save the exported map file.

  • volume_name – Name of the volume.

  • surface_type – Type of the surface.

  • surface_comment – Comment associated with the surface.

  • format – Format of the exported map.

schrodinger.maestro_utils.surface_manager.commands.duplicate_surface(surface_name: str, entry_id: int)

Duplicate the selected surface.

Parameters:

  • surface_name – Name of the surface to duplicate.

  • entry_id – Entry ID of the entry to which the surface is associated.

schrodinger.maestro_utils.surface_manager.commands.split_paired_surface(surface_name: str, entry_id: int, volume_name: str)

Split a paired surface.

Parameters:

  • surface_name – Name of the surface to split.

  • entry_id – Entry ID of the entry to which the surface is associated.

  • volume_name – Name of the volume associated with the surface.

schrodinger.maestro_utils.surface_manager.commands.display_volume(entry_id: int, display: bool, volume_name: str)

Execute Maestro Command to update display of volumes.

Parameters:

  • entry_id – Entry ID of the entry to which the volume is associated.

  • display – Boolean indicating whether to display the volume.

  • volume_name – Name of the volume.

schrodinger.maestro_utils.surface_manager.commands.set_surface_style(entry_id: int, surface_name: str, style: Style)

Execute Maestro Command to set the style of a surface.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • surface_name – Name of the surface.

  • style – Style to set for the surface (e.g., Style.solid, Style.mesh, Style.dots).

schrodinger.maestro_utils.surface_manager.commands.set_surface_transparency(entry_id: int, surface_name: str, transparency: int)

Execute Maestro Command to set surface front face transparency.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • surface_name – Name of the surface.

  • transparency – Front face transparency percentage (0-100).

schrodinger.maestro_utils.surface_manager.commands.set_surface_transparency_back(entry_id: int, surface_name: str, transparency: int)

Execute Maestro Command to set surface back face transparency.

Parameters:

  • entry_id – Entry ID of the entry to which the surface is associated.

  • surface_name – Name of the surface.

  • transparency – Back face transparency percentage (0-100).