Rosetta
Classes | Functions | Variables
pyrosetta.distributed.viewer.core Namespace Reference

Classes

class  Viewer
 
class  ViewerInputError
 

Functions

def init (packed_and_poses_and_pdbs=None, window_size=None, modules=None, delay=None, continuous_update=None, *args, **kwargs)
 
def expand_notebook ()
 

Variables

string __author__ = "Jason C. Klima"
 
 _logger = logging.getLogger("pyrosetta.distributed.viewer")
 
 __ipython_version__ = get_package_version("ipython")
 

Function Documentation

◆ expand_notebook()

def pyrosetta.distributed.viewer.core.expand_notebook ( )
Expand Jupyter notebook cell to maximum width.

◆ init()

def pyrosetta.distributed.viewer.core.init (   packed_and_poses_and_pdbs = None,
  window_size = None,
  modules = None,
  delay = None,
  continuous_update = None,
args,
**  kwargs 
)
Initialize the Viewer object.

Parameters
----------
first : required
    `packed_and_poses_and_pdbs`

    `PackedPose`, `Pose`, or `str` of a valid path to a .pdb file, or a `list`, `set`, or `tuple` of these objects.

second : optional
    `window_size`

    `list` or `tuple` of `int` or `float` values for the (width, height) dimensions of the displayed window screen size.
    Default: (1200, 800)

third : optional
    `modules`

    `list` of instantiated visualization modules to run upon changing amongst `packed_and_poses_and_pdbs` objects
    with the slider, matching the namespace `pyrosetta.distributed.viewer.set*`
    Default: []

fourth : optional
    `delay`

    `float` or `int` time delay in seconds before rendering the Viewer in a Jupyter notebook, which is useful to prevent
    overburdening the Jupyter notebook client if `for` looping over quick modifications to a `Pose`, and should be >= 0.
    Default: 0.25

fifth : optional
    `continuous_update`

    `True` or `False`. When using the interactive slider widget, `False` restricts rendering to mouse release events.
    Default: False

Returns
-------
A Viewer instance.

References kmeans_adaptive_kernel_density_bb_dependent_rotlib._, run_backbone.float, ObjexxFCL.len(), basic::database.open(), pyrosetta.distributed.io.to_pdbstring(), pyrosetta.distributed.packed_pose.core.to_pose(), and basic::options::OptionKeys::in::file.zip.

Variable Documentation

◆ __author__

string pyrosetta.distributed.viewer.core.__author__ = "Jason C. Klima"
private

◆ __ipython_version__

pyrosetta.distributed.viewer.core.__ipython_version__ = get_package_version("ipython")
private

◆ _logger

pyrosetta.distributed.viewer.core._logger = logging.getLogger("pyrosetta.distributed.viewer")
private