schrodinger.job.host_check module

This module provides functions to support hosts-file and remote-command configuration in the Configuration GUI.

class schrodinger.job.host_check.Error(message, level=None, description='', advice='', output='')

Bases: object

An Error represents an system-level issue that prevents remote commands executed via ssh from succeeding.

__init__(message, level=None, description='', advice='', output='')

Initialize self. See help(type(self)) for accurate signature.

__class__

alias of builtins.type

__delattr__

Implement delattr(self, name).

__dict__ = mappingproxy({'__module__': 'schrodinger.job.host_check', '__doc__': '\n An Error represents an system-level issue that prevents remote\n commands executed via ssh from succeeding.\n ', '__init__': <function Error.__init__>, '__dict__': <attribute '__dict__' of 'Error' objects>, '__weakref__': <attribute '__weakref__' of 'Error' objects>})

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__module__ = 'schrodinger.job.host_check'

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

schrodinger.job.host_check.ssh_check(host, user='')

Check whether remote commands to the given host succeed or not. An alternate remote account name can be specified.

Results are returned in a list of Error objects reporting any serious problems uncovered with remote commands to the specified host.

The current implementation involves executing a separate test program to diagnose remote-command issues, remote_command.pl.

schrodinger.job.host_check.host_check(entry, hostfile='', cwd=None)

Check whether jobs can be run successfully using the given host entry. A non-default hosts file can be specified; otherwise the usual hosts file is used.

Results are returned in a list of Error objects reporting any serious problems uncovered with jobs launched to the specified host entry.

The current implementation involves executing a separate test program, “$SCHRODINGER/installation_check”, to manage the test job and diagnose the problem, if it fails.

Parameters:cwd (str) – Use to set the current working directory.