resource_manager

Bindings for basic::resource_manager namespace

class pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration

Bases: pybind11_builtins.pybind11_object

The %FallbackConfiguration class describes how a resource should be created if the ResourceManager is not being used, i.e., if resources have been specified through flags on the command line instead of through a resource-definition file.

A protocol will still query the ResourceManager for its desired resource in such a case (by its “resource_description”) and if no resource has been provided for that description, then the ResourceManager will ask the FallbackConfigurationFactory for the %FallbackConfiguration that has been registered for that resource description (this registration logic is handled by the FallbackConfigurationCreator) and ask it to provide the information necessary to create the appropriate resource from the command line.

For example, a user can define the loop they are interested in modeling to the loop-modeling protocol via the LoopsFileData resource. The loop modeling protocol once was but is no longer responsible for opening a text file and creating a LoopsFileData object from that text file; instead it asks the ResourceManager directly for the resource. For the sake of backwards compatibility, the ResourceManager must have some way of creating a LoopsFileData object from the command line. If someone is using the loop modeling application, but does not provide a resource definition, then the LoopsFileFallbackConfiguration (derived from %FallbackConfiguration) will be called upon by the ResourceManager for three things: 1) the name of the ResourceLoader to use to create the resource (“LoopsFile”), 2) the locator_id for the Resource (which it goes to the command line to find), and 3) a ResourceOptionsOP which is either null (meaning “use the default”) or is in some way initialized with options from the command line. With these three bits, the ResourceManager will go the appropriate ResourceLoader and request the construction of the Resource as usual, opening the file using the default ResourceLocator (for the JD2ResourceManager, this is the FileSystemResourceLocator).

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration, arg0: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration) -> None
__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration, : pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration) → pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration

C++: basic::resource_manager::FallbackConfiguration::operator=(const class basic::resource_manager::FallbackConfiguration &) –> class basic::resource_manager::FallbackConfiguration &

could_not_create_resource_error_message(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration, desc: str) → str
If the %FallbackConfiguration has not been provided the appropriate set
of command line flags needed to construct the Resource given the resource description, then return an error message informing the user what options must be provided on the command line.

C++: basic::resource_manager::FallbackConfiguration::could_not_create_resource_error_message(const class std::basic_string<char> &) const –> std::string

fallback_specified(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration, desc: str) → bool
Return true if a fallback been provided for the given resource description.
It is possible that the fallback configuration would be unable to deliver a requested resource, e.g. if the appropriate command line option has not been provided.

C++: basic::resource_manager::FallbackConfiguration::fallback_specified(const class std::basic_string<char> &) const –> bool

get_locator_id(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration, desc: str) → str
Return the locator id that the resource locator should use to
find the data used to construct the desired resource - e.g. the file name.

C++: basic::resource_manager::FallbackConfiguration::get_locator_id(const class std::basic_string<char> &) const –> std::string

get_resource_loader(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration, desc: str) → str
Return the name of the resource loader that should be used to instantiate the
desired resource

C++: basic::resource_manager::FallbackConfiguration::get_resource_loader(const class std::basic_string<char> &) const –> std::string

get_resource_options(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration, desc: str) → pyrosetta.rosetta.basic.resource_manager.ResourceOptions
Return a pointer to the ResourceOptions object that the
ResourceLoader will use to instantiate the given resource. Return 0 if the default ResourceOptions specified by the appropriate ResourceLoader should be used.

C++: basic::resource_manager::FallbackConfiguration::get_resource_options(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceOptions>

class pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator

Bases: pybind11_builtins.pybind11_object

The ResourceManager looks to a FallbackConfiguration when a resource is requested by a resource description string but no resource definition file has been provided. In such a case, the FallbackConfiguration will provide the information the ResourceManager needs to create the resource. It’s the %FallbackConfigurationCreator’s job to inform the ResourceManager which FallbackConfiguration to talk to.

Each class derived from the %FallbackConfigurationCreator will instantiate a single FallbackConfiguration and act to pair a string, a “resource description,” with that FallbackConfiguration. For example “LoopFile” as a resource description will be paired by the LoopFileFallbackConfigurationCreator with the LoopFileFallbackConfiguration. Multiple resource descriptions can be paired with a single FallbackConfiguration.

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator, arg0: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator) -> None
__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator, : pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator) → pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator

C++: basic::resource_manager::FallbackConfigurationCreator::operator=(const class basic::resource_manager::FallbackConfigurationCreator &) –> class basic::resource_manager::FallbackConfigurationCreator &

create_fallback_configuration(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator) → pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration

C++: basic::resource_manager::FallbackConfigurationCreator::create_fallback_configuration() const –> class std::shared_ptr<class basic::resource_manager::FallbackConfiguration>

resource_description(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator) → str

C++: basic::resource_manager::FallbackConfigurationCreator::resource_description() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationFactory

Bases: pyrosetta.rosetta.utility.SingletonBase_basic_resource_manager_FallbackConfigurationFactory_t

The %FallbackConfigurationFactory is a singleton factory with which FallbackConfigurationCreator objects should be registered. The “fallback” system serves as a mechanism for preserving command-line functionality even while switching more protocols from requesting resources from the ResourceManager rather than reading directly from the command line.

When a resource with a particular resource-description string is requested from the ResourceManager, and the ResourceManager does not have any instructions on how to load a resource matching that description, then the ResourceManager will then ask the FallbackConfigurationFactory for help. The FallbackConfigurationFactory can first answer “does this resource description match any resource descriptions for which you have a registered FallbackConfigurationCreator?” and if the answer is “yes”, then the ResourceManager can request that FallbackConfigurationCreator and ask, first, if it is able to construct a resource (FallbackConfigurations often read from the command line, and it’s possible that the required flags have not been put on the command line), and if so, then request data from the FallbackConfiguration needed to contruct that resource.

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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).

create_fallback_configuration(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationFactory, resource_description: str) → pyrosetta.rosetta.basic.resource_manager.FallbackConfiguration

C++: basic::resource_manager::FallbackConfigurationFactory::create_fallback_configuration(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::FallbackConfiguration>

factory_register(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationFactory, creator: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationCreator) → None

C++: basic::resource_manager::FallbackConfigurationFactory::factory_register(class std::shared_ptr<class basic::resource_manager::FallbackConfigurationCreator>) –> void

get_instance() → basic::resource_manager::FallbackConfigurationFactory

C++: utility::SingletonBase<basic::resource_manager::FallbackConfigurationFactory>::get_instance() –> class basic::resource_manager::FallbackConfigurationFactory *

has_fallback_for_resource(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationFactory, desc: str) → bool

C++: basic::resource_manager::FallbackConfigurationFactory::has_fallback_for_resource(const class std::basic_string<char> &) const –> bool

set_throw_on_double_registration(self: pyrosetta.rosetta.basic.resource_manager.FallbackConfigurationFactory) → None
Only useful for unit testing. Since factory registration happens (sometimes) at
load time, there may be no one to catch a thrown exception in the event of a name collision two FallbackConfigurationCreators that register for the same

C++: basic::resource_manager::FallbackConfigurationFactory::set_throw_on_double_registration() –> void

class pyrosetta.rosetta.basic.resource_manager.JobOptions

Bases: pybind11_builtins.pybind11_object

The %JobOptions class holds job-specific options (i.e. command line flags). It can be used by the ResourceManager to hold options for a particular job, so that the ResourceManager can retrieve those options as needed. It is basically a bag for 12 OptionKey/OptionKeyValue maps, one for every kind of OptionKey.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, rhs: pyrosetta.rosetta.basic.resource_manager.JobOptions) → bool

C++: basic::resource_manager::JobOptions::operator==(const class basic::resource_manager::JobOptions &) const –> bool

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.JobOptions) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, arg0: pyrosetta.rosetta.basic.resource_manager.JobOptions) -> None
__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.

__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__(self: pyrosetta.rosetta.basic.resource_manager.JobOptions) → str
__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).

add_option(*args, **kwargs)

Overloaded function.

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanOptionKey, val: bool) -> None

Set the value for the indicated boolean option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::BooleanOptionKey, bool) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey, val: pyrosetta.rosetta.utility.vector1_bool) -> None

Set the value for the indicated boolean-vector option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::BooleanVectorOptionKey, const class utility::vector1<bool, class std::allocator<bool> > &) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileOptionKey, val: pyrosetta.rosetta.utility.file.FileName) -> None

Set the value for the indicated file option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::FileOptionKey, const class utility::file::FileName &) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey, val: pyrosetta.rosetta.utility.vector1_utility_file_FileName) -> None

Set the value for the indicated file-vector option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::FileVectorOptionKey, const class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> > &) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerOptionKey, val: int) -> None

Set the value for the indicated integer option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::IntegerOptionKey, int) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey, val: pyrosetta.rosetta.utility.vector1_int) -> None

Set the value for the indicated integer-vector option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::IntegerVectorOptionKey, const class utility::vector1<int, class std::allocator<int> > &) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathOptionKey, val: pyrosetta.rosetta.utility.file.PathName) -> None

Set the value for the indicated path option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::PathOptionKey, const class utility::file::PathName &) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey, val: pyrosetta.rosetta.utility.vector1_utility_file_PathName) -> None

Set the value for the indicated path-vector option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::PathVectorOptionKey, const class utility::vector1<class utility::file::PathName, class std::allocator<class utility::file::PathName> > &) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealOptionKey, val: float) -> None

Set the value for the indicated real option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::RealOptionKey, double) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey, val: pyrosetta.rosetta.utility.vector1_double) -> None

Set the value for the indicated real-vector option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::RealVectorOptionKey, const class utility::vector1<double, class std::allocator<double> > &) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringOptionKey, val: str) -> None

Set the value for the indicated string option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::StringOptionKey, class std::basic_string<char>) –> void

  1. add_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey, val: pyrosetta.rosetta.utility.vector1_std_string) -> None

Set the value for the indicated string-vector option

C++: basic::resource_manager::JobOptions::add_option(class utility::options::StringVectorOptionKey, const class utility::vector1<class std::basic_string<char>, class std::allocator<class std::basic_string<char> > > &) –> void

assign(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, : pyrosetta.rosetta.basic.resource_manager.JobOptions) → pyrosetta.rosetta.basic.resource_manager.JobOptions

C++: basic::resource_manager::JobOptions::operator=(const class basic::resource_manager::JobOptions &) –> class basic::resource_manager::JobOptions &

get_option(*args, **kwargs)

Overloaded function.

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> bool

Return the value of the indicated boolean option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::BooleanOptionKey) const –> bool

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_bool

Return the value of the indicated boolean-vector option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::BooleanVectorOptionKey) const –> const class utility::vector1<bool, class std::allocator<bool> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> pyrosetta.rosetta.utility.file.FileName

Return the value of the indicated file option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::FileOptionKey) const –> const class utility::file::FileName &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_utility_file_FileName

Return the value of the indicated file-vector option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::FileVectorOptionKey) const –> const class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> int

Return the value of the indicated integer option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::IntegerOptionKey) const –> int

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_int

Return the value of the indicated integer-vector option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::IntegerVectorOptionKey) const –> const class utility::vector1<int, class std::allocator<int> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> pyrosetta.rosetta.utility.file.PathName

Return the value of the indicated path option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::PathOptionKey) const –> const class utility::file::PathName &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_utility_file_PathName

Return the value of the indicated path-vector option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::PathVectorOptionKey) const –> const class utility::vector1<class utility::file::PathName, class std::allocator<class utility::file::PathName> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> float

Return the value of the indicated real option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::RealOptionKey) const –> double

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_double

Return the value of the indicated real-vector option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::RealVectorOptionKey) const –> const class utility::vector1<double, class std::allocator<double> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> str

Return the value of the indicated string option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::StringOptionKey) const –> const std::string &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_std_string

Return the value of the indicated string-vector option

C++: basic::resource_manager::JobOptions::get_option(class utility::options::StringVectorOptionKey) const –> const class utility::vector1<std::string, class std::allocator<std::string > > &

has_option(*args, **kwargs)

Overloaded function.

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> bool

Return true if a value for the indicated boolean option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::BooleanOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> bool

Return true if a value for the indicated boolean-vector option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::BooleanVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> bool

Return true if a value for the indicated file option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::FileOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> bool

Return true if a value for the indicated file-vector option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::FileVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> bool

Return true if a value for the indicated integer option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::IntegerOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> bool

Return true if a value for the indicated integer-vector option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::IntegerVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> bool

Return true if a value for the indicated path option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::PathOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> bool

Return true if a value for the indicated path-vector option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::PathVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> bool

Return true if a value for the indicated real option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::RealOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> bool

Return true if a value for the indicated real-vector option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::RealVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> bool

Return true if a value for the indicated string option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::StringOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> bool

Return true if a value for the indicated string-vector option has been set

C++: basic::resource_manager::JobOptions::has_option(class utility::options::StringVectorOptionKey) const –> bool

insertion_order(self: pyrosetta.rosetta.basic.resource_manager.JobOptions) → pyrosetta.rosetta.std.list_std_pair_utility_options_OptionTypes_std_string_std_allocator_std_pair_utility_options_OptionTypes_std_string_t

C++: basic::resource_manager::JobOptions::insertion_order() const –> const class std::list<struct std::pair<enum utility::options::OptionTypes, std::string >, class std::allocator<struct std::pair<enum utility::options::OptionTypes, std::string > > > &

remove_option(*args, **kwargs)

Overloaded function.

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> None

Unset the value for the indicated boolean option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::BooleanOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> None

Unset the value for the indicated boolean-vector option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::BooleanVectorOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> None

Unset the value for the indicated file option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::FileOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> None

Unset the value for the indicated file-vector option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::FileVectorOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> None

Unset the value for the indicated integer option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::IntegerOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> None

Unset the value for the indicated integer-vector option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::IntegerVectorOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> None

Unset the value for the indicated path option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::PathOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> None

Unset the value for the indicated path-vector option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::PathVectorOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> None

Unset the value for the indicated real option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::RealOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> None

Unset the value for the indicated real-vector option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::RealVectorOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> None

Unset the value for the indicated string option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::StringOptionKey) –> void

  1. remove_option(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> None

Unset the value for the indicated string-vector option

C++: basic::resource_manager::JobOptions::remove_option(class utility::options::StringVectorOptionKey) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, out: pyrosetta.rosetta.std.ostream) → None

Describe this %JobOptions to the given output stream

C++: basic::resource_manager::JobOptions::show(class std::basic_ostream<char> &) const –> void

track_insertion_order(self: pyrosetta.rosetta.basic.resource_manager.JobOptions, setting: bool) → None

C++: basic::resource_manager::JobOptions::track_insertion_order(bool) –> void

class pyrosetta.rosetta.basic.resource_manager.LazyResourceManager

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceManager

This is a mule class, meant to be derived from. It’s job is to hold ResourceOptions and ResourceLocator objects by name (tag) as well as the ResourceConfigurations which serve as complete descriptions for how to construct a Resource. It should be thought of as a mule by classes that derive from it: it won’t do anything on its own, but it can be directed to do things. The point of the class is to ake it easier to create ResourceManagers besides the JD2ResourceManager, which, at the time of this documentation, is the only class that derives from the LazyResourceManager.

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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__(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager) → str
__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).

add_job_options(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, job_tag: str, job_options: pyrosetta.rosetta.basic.resource_manager.JobOptions) → None

C++: basic::resource_manager::LazyResourceManager::add_job_options(const class std::basic_string<char> &, class std::shared_ptr<class basic::resource_manager::JobOptions>) –> void

add_resource_configuration(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_tag: str, resource_configuration: pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration) → None

C++: basic::resource_manager::LazyResourceManager::add_resource_configuration(const class std::basic_string<char> &, const struct basic::resource_manager::ResourceConfiguration &) –> void

add_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, locator_tag: str, resource_locator: basic::resource_manager::ResourceLocator) → None

C++: basic::resource_manager::LazyResourceManager::add_resource_locator(const class std::basic_string<char> &, class std::shared_ptr<class basic::resource_manager::ResourceLocator>) –> void

add_resource_options(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_options_tag: str, resource_options: pyrosetta.rosetta.basic.resource_manager.ResourceOptions) → None

C++: basic::resource_manager::LazyResourceManager::add_resource_options(const class std::basic_string<char> &, class std::shared_ptr<class basic::resource_manager::ResourceOptions>) –> void

add_resource_tag_by_job_tag(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_description: str, job_tag: str, resource_tag: str) → None

C++: basic::resource_manager::LazyResourceManager::add_resource_tag_by_job_tag(const class std::basic_string<char> &, const class std::basic_string<char> &, const class std::basic_string<char> &) –> void

assign(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, : pyrosetta.rosetta.basic.resource_manager.LazyResourceManager) → pyrosetta.rosetta.basic.resource_manager.LazyResourceManager

C++: basic::resource_manager::LazyResourceManager::operator=(const class basic::resource_manager::LazyResourceManager &) –> class basic::resource_manager::LazyResourceManager &

clear(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager) → None
wipe out all data; useful for unit testing, but hard to fathom how it would be useful
otherwise.

C++: basic::resource_manager::LazyResourceManager::clear() –> void

create_resources(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, : str) → None
Create all the resources for a particular job; this should be implemented by the derived
class. The implementation in this class calls utility::exit

C++: basic::resource_manager::LazyResourceManager::create_resources(const class std::basic_string<char> &) –> void

find_resource_configuration(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_tag: str) → pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration

C++: basic::resource_manager::LazyResourceManager::find_resource_configuration(const class std::basic_string<char> &) const –> const struct basic::resource_manager::ResourceConfiguration &

find_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, locator_tag: str) → basic::resource_manager::ResourceLocator

C++: basic::resource_manager::LazyResourceManager::find_resource_locator(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceLocator>

find_resource_options(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_options_tag: str) → pyrosetta.rosetta.basic.resource_manager.ResourceOptions

C++: basic::resource_manager::LazyResourceManager::find_resource_options(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceOptions>

find_resource_tag_by_job_tag(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_description: str, job_tag: str) → str

C++: basic::resource_manager::LazyResourceManager::find_resource_tag_by_job_tag(const class std::basic_string<char> &, const class std::basic_string<char> &) const –> std::string

free_resource_by_job_tag(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_description: str, job_tag: str) → None

C++: basic::resource_manager::LazyResourceManager::free_resource_by_job_tag(const class std::basic_string<char> &, const class std::basic_string<char> &) –> void

free_resource_by_tag(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_tag: str) → None

C++: basic::resource_manager::LazyResourceManager::free_resource_by_tag(const class std::basic_string<char> &) –> void

get_count_of_jobs_associated_with_resource_tag(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_tag: str) → int

C++: basic::resource_manager::LazyResourceManager::get_count_of_jobs_associated_with_resource_tag(const class std::basic_string<char> &) const –> unsigned long

get_instance() → pyrosetta.rosetta.basic.resource_manager.ResourceManager
Deprecated access to a global (not-quite singleton) ResourceManager instance that
should be removed

C++: basic::resource_manager::ResourceManager::get_instance() –> class basic::resource_manager::ResourceManager *

get_job_options(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, job_tag: str) → pyrosetta.rosetta.basic.resource_manager.JobOptions

C++: basic::resource_manager::LazyResourceManager::get_job_options(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::JobOptions>

get_option(*args, **kwargs)

Overloaded function.

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> bool

Retrieve the boolean value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::BooleanOptionKey) const –> bool

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_bool

Retrieve the vector of boolean values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::BooleanVectorOptionKey) const –> const class utility::vector1<bool, class std::allocator<bool> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> pyrosetta.rosetta.utility.file.FileName

Retrieve the FileName value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::FileOptionKey) const –> const class utility::file::FileName &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_utility_file_FileName

Retrieve the vector of FileName values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::FileVectorOptionKey) const –> const class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> int

Retrieve the integer value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::IntegerOptionKey) const –> int

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_int

Retrieve the vector of integer values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::IntegerVectorOptionKey) const –> const class utility::vector1<int, class std::allocator<int> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> pyrosetta.rosetta.utility.file.PathName

Retrieve the PathName value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::PathOptionKey) const –> const class utility::file::PathName &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_utility_file_PathName

Retrieve the vector of PathName values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::PathVectorOptionKey) const –> const class utility::vector1<class utility::file::PathName, class std::allocator<class utility::file::PathName> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> float

Retrieve the Real value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::RealOptionKey) const –> double

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_double

Retrieve the vector of Real values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::RealVectorOptionKey) const –> const class utility::vector1<double, class std::allocator<double> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> str

Retrieve the string value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::StringOptionKey) const –> const std::string &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_std_string

Retrieve the vector of string values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::StringVectorOptionKey) const –> const class utility::vector1<std::string, class std::allocator<std::string > > &

get_resource_tags_for_job_tag(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, job_tag: str) → pyrosetta.rosetta.std.list_std_string_std_allocator_std_string_t

C++: basic::resource_manager::LazyResourceManager::get_resource_tags_for_job_tag(const class std::basic_string<char> &) const –> class std::list<std::string, class std::allocator<std::string > >

has_job_options(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, job_tag: str) → bool

C++: basic::resource_manager::LazyResourceManager::has_job_options(const class std::basic_string<char> &) const –> bool

has_option(*args, **kwargs)

Overloaded function.

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::BooleanOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::BooleanVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::FileOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::FileVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::IntegerOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::IntegerVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::PathOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::PathVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::RealOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::RealVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::StringOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::StringVectorOptionKey) const –> bool

has_resource(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_tag: str) → bool

Does a resource with a given name exist?

C++: basic::resource_manager::LazyResourceManager::has_resource(const class std::basic_string<char> &) const –> bool

has_resource_configuration(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_tag: str) → bool

has a ResourceConfiguration been provided to the LazyResourceManager for a Resource with a particular ResourceTag?

C++: basic::resource_manager::LazyResourceManager::has_resource_configuration(const class std::basic_string<char> &) const –> bool

has_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, locator_tag: str) → bool

has a ResourceLocator object been provided to the LazyResourceManager which has a particular LocatorTag?

C++: basic::resource_manager::LazyResourceManager::has_resource_locator(const class std::basic_string<char> &) const –> bool

has_resource_options(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_options_tag: str) → bool

has a ResourceOptions object been provided to the LazyResourceManager which has a particular ResourceOptionsTag?

C++: basic::resource_manager::LazyResourceManager::has_resource_options(const class std::basic_string<char> &) const –> bool

has_resource_tag_by_job_tag(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, resource_description: str, job_tag: str) → bool

C++: basic::resource_manager::LazyResourceManager::has_resource_tag_by_job_tag(const class std::basic_string<char> &, const class std::basic_string<char> &) const –> bool

has_resource_with_description(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, resource_description: str) → bool
A protocol may ask whether a resource with a given resource description
has been provided. It is possible that some resources are available sometimes when running a protocol, but not always (e.g. when running abinitio, sometimes you don’t know what the native structure is).

C++: basic::resource_manager::ResourceManager::has_resource_with_description(const class std::basic_string<char> &) –> bool

mark_job_tag_as_complete(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, job_tag: str) → None

remove the Job tag from incomplete_job_sets_ for each resource

C++: basic::resource_manager::LazyResourceManager::mark_job_tag_as_complete(const class std::basic_string<char> &) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.LazyResourceManager, out: pyrosetta.rosetta.std.ostream) → None

C++: basic::resource_manager::LazyResourceManager::show(class std::basic_ostream<char> &) const –> void

class pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration

Bases: pybind11_builtins.pybind11_object

The set of strings necessary to describe how a resource should be constructed.

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration, arg0: pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration) -> None
__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.

__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__(self: pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration) → str
__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration, : pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration) → pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration

C++: basic::resource_manager::ResourceConfiguration::operator=(const struct basic::resource_manager::ResourceConfiguration &) –> struct basic::resource_manager::ResourceConfiguration &

show(self: pyrosetta.rosetta.basic.resource_manager.ResourceConfiguration, out: pyrosetta.rosetta.std.ostream) → None

C++: basic::resource_manager::ResourceConfiguration::show(class std::basic_ostream<char> &) const –> void

class pyrosetta.rosetta.basic.resource_manager.ResourceLoader

Bases: pybind11_builtins.pybind11_object

The ResourceLoader is responsible for instantiating a Resource object and initializing it. In order to do so, the ResourceLoader is given an input stream and a ResourceOptions object. Note that the ResourceOptions object has to be of the right type, or the ResourceLoader will not be able to read the data that it needs out of it. If the ResourceLoader is given the wrong kind of ResourceOptions object, it will throw an exception.

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoader, : pyrosetta.rosetta.basic.resource_manager.ResourceLoader) → pyrosetta.rosetta.basic.resource_manager.ResourceLoader

C++: basic::resource_manager::ResourceLoader::operator=(const class basic::resource_manager::ResourceLoader &) –> class basic::resource_manager::ResourceLoader &

default_options(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoader) → pyrosetta.rosetta.basic.resource_manager.ResourceOptions

C++: basic::resource_manager::ResourceLoader::default_options() const –> class std::shared_ptr<class basic::resource_manager::ResourceOptions>

class pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator

Bases: pybind11_builtins.pybind11_object

Instantiates a ResourceLoader as part of the ResourceLoaderFactory scheme. Derived classes should be registered with the ResourceLoaderFactory in one of the library init.cc files with a ResourceLoaderRegistrator

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator, arg0: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator) -> None
__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator, : pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator

C++: basic::resource_manager::ResourceLoaderCreator::operator=(const class basic::resource_manager::ResourceLoaderCreator &) –> class basic::resource_manager::ResourceLoaderCreator &

create_resource_loader(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLoader

Instantiate a ResourceLoader

C++: basic::resource_manager::ResourceLoaderCreator::create_resource_loader() const –> class std::shared_ptr<class basic::resource_manager::ResourceLoader>

loader_type(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator) → str

Give the name of the ResourceLoader that this Creator will instantiate.

C++: basic::resource_manager::ResourceLoaderCreator::loader_type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.ResourceLoaderFactory

Bases: pyrosetta.rosetta.utility.SingletonBase_basic_resource_manager_ResourceLoaderFactory_t

Instantiates ResourceLoaders. Creators may be registered with the Factory at any point, though it is recommended they be registered at load time. If two Creators are registered and they both give the same name for the ResourceLoader they say they will instantiate, then the Factory will exit with an error message.

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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).

available_resource_loaders(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderFactory) → pyrosetta.rosetta.std.list_std_string_std_allocator_std_string_t

Return a list of all the resource loaders available

C++: basic::resource_manager::ResourceLoaderFactory::available_resource_loaders() const –> class std::list<std::string, class std::allocator<std::string > >

create_resource_loader(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderFactory, loader_type: str) → pyrosetta.rosetta.basic.resource_manager.ResourceLoader
Instantiates a resource loader ofa given type; throws
an exception if no loader with this type has been previously registered.

C++: basic::resource_manager::ResourceLoaderFactory::create_resource_loader(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceLoader>

factory_register(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderFactory, creator: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderCreator) → None
Register a ResourceLoaderCreator with the factory. The factory
asks the Creator for the name of the ResourceLoader that it will create; if another Creator has already registered with the factory that proports to instantiate another ResourceLoader with the same name, then it will exit with an error message, or, if set_throw_on_double_registration() has previously been called, throw an exception.

C++: basic::resource_manager::ResourceLoaderFactory::factory_register(class std::shared_ptr<class basic::resource_manager::ResourceLoaderCreator>) –> void

get_instance() → basic::resource_manager::ResourceLoaderFactory

C++: utility::SingletonBase<basic::resource_manager::ResourceLoaderFactory>::get_instance() –> class basic::resource_manager::ResourceLoaderFactory *

has_resource_loader(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderFactory, loader_type: str) → bool
Returns true if a resource loader of the given type has been
registered with the factory

C++: basic::resource_manager::ResourceLoaderFactory::has_resource_loader(const class std::basic_string<char> &) const –> bool

set_throw_on_double_registration(self: pyrosetta.rosetta.basic.resource_manager.ResourceLoaderFactory) → None
Only useful for unit testing. Since factory registration happens (sometimes) at
load time, there may be no one to catch a thrown exception in the event of a name collision two FallbackConfigurationCreators that register for the same

C++: basic::resource_manager::ResourceLoaderFactory::set_throw_on_double_registration() –> void

class pyrosetta.rosetta.basic.resource_manager.ResourceLocator

Bases: pybind11_builtins.pybind11_object

%ResourceLocator classes are responsible for retrieving data from a data store that will be used to construct a Resource. This data store could be a file system or a database or any other place where data is stored.

The ResourceManager asks the ResourceLocator to produce a ResourceStream object when given a “locator_id.” A “locator_id” is what’s needed to identify a data source from a data store: for example, for the FileSystemResourceLocator, the locator id is a file name; for the DatabaseResourceLocator, it would be a database query.

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, locator_tag: str) -> None
  3. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, arg0: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) -> None
__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, : pyrosetta.rosetta.basic.resource_manager.ResourceLocator) → pyrosetta.rosetta.basic.resource_manager.ResourceLocator

C++: basic::resource_manager::ResourceLocator::operator=(const class basic::resource_manager::ResourceLocator &) –> class basic::resource_manager::ResourceLocator &

locate_resource_stream(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, locator_id: str) → pyrosetta.rosetta.basic.resource_manager.ResourceStream
Create and return a ResourceStream object from the given locator_id
so that its stream can be passed to the ResourceLoader

C++: basic::resource_manager::ResourceLocator::locate_resource_stream(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceStream>

locator_tag(*args, **kwargs)

Overloaded function.

  1. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, locator_tag: str) -> None

Set the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag(const class std::basic_string<char> &) –> void

  1. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) -> str

Return the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, tag: utility::tag::Tag) → None
Initialize the parameters for this %ResourceLocator from the contents of
an XML file.

C++: basic::resource_manager::ResourceLocator::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, out: pyrosetta.rosetta.std.ostream) → None

Write a description of this %ResourceLocator to an out stream

C++: basic::resource_manager::ResourceLocator::show(class std::basic_ostream<char> &) const –> void

type(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) → str
Return the class name for this %ResourceLocator instance.
This function allows for better error message delivery.

C++: basic::resource_manager::ResourceLocator::type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator

Bases: pybind11_builtins.pybind11_object

The %ResourceLocatorCreator class serves to link the name of a locator type and the (derived) ResourceLocator class that’s responsible for retrieving data from a data store.

__delattr__

Implement delattr(self, name).

__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__(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator) → None
__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator, : pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator

C++: basic::resource_manager::ResourceLocatorCreator::operator=(const class basic::resource_manager::ResourceLocatorCreator &) –> class basic::resource_manager::ResourceLocatorCreator &

create_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLocator

C++: basic::resource_manager::ResourceLocatorCreator::create_resource_locator() const –> class std::shared_ptr<class basic::resource_manager::ResourceLocator>

locator_type(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator) → str

C++: basic::resource_manager::ResourceLocatorCreator::locator_type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.ResourceLocatorFactory

Bases: pyrosetta.rosetta.utility.SingletonBase_basic_resource_manager_ResourceLocatorFactory_t

The %ResourceLocatorFactory instantiates ResourceLocator objects given their corresponding locator-type strings. It uses the load-time factory registration scheme, meaning that it is a singleton and takes an instance of a Creator object (a ResourceLocatorCreator) in its “factory_register” method. Templated instances of the ResourceLocatorRegistrator classes should be placed in the library init.cc files (e.g. core/init/init.cc or protocols/init/init.ResourceLocatorRegistrators.ihh)

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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).

create_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorFactory, locator_type: str, locator_tag: str, tags: utility::tag::Tag) → pyrosetta.rosetta.basic.resource_manager.ResourceLocator

Create a ResourceLocator given its locator_type, giving the newly created instance the name locator_tag

C++: basic::resource_manager::ResourceLocatorFactory::create_resource_locator(const class std::basic_string<char> &, const class std::basic_string<char> &, class std::shared_ptr<const class utility::tag::Tag>) const –> class std::shared_ptr<class basic::resource_manager::ResourceLocator>

factory_register(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorFactory, creator: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator) → None
This function is called on the singleton instance to give a ResourceLocatorCreator to the
factory, usually through the constructor of a ResourceLocatorRegistrator class.

C++: basic::resource_manager::ResourceLocatorFactory::factory_register(class std::shared_ptr<class basic::resource_manager::ResourceLocatorCreator>) –> void

get_instance() → basic::resource_manager::ResourceLocatorFactory

C++: utility::SingletonBase<basic::resource_manager::ResourceLocatorFactory>::get_instance() –> class basic::resource_manager::ResourceLocatorFactory *

set_throw_on_double_registration(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorFactory) → None
Only useful for unit testing. Since factory registration happens (sometimes) at
load time, there may be no one to catch a thrown exception in the event of a name collision between two ResourceLocatorCreators that register for the same name.

C++: basic::resource_manager::ResourceLocatorFactory::set_throw_on_double_registration() –> void

class pyrosetta.rosetta.basic.resource_manager.ResourceManager

Bases: pybind11_builtins.pybind11_object

The ResourceManager is a singleton class responsible for holding, distributing, and eventually deallocating resources which may be shared between multiple jobs. A protocol may communicate directly with the ResourceManager, requesting resources, but remaining unaware of where those resources came from, or whether the same resource is being used in multiple contexts.

A protocol should request a resource using a “resource description” (a string), which is a generic way of referring to a piece of data. For example, a protocol might request the native Pose, by asking for a resource with the description “native”. The ResourceManager’s job is to return the resource matching that description; when the “native” is requested, it is requested in some context (e.g. in a protocol running under JD2) and the ResourceManager serves as a backbone in which to deliever context-specific data to the protocol, while keeping the protocol ignorant and independent of the surrounding context. That way protocols can run in JD2 just as effectively as the could run in some other job-management environment, without having to assume responsibility for instantiating resources themselves.

NOTE: Because the logic for deciding which of the derived ResourceManager classes should be instantiated depends on the options system, the ResourceManager should not be requested until after core::init::init() has been called (i.e. it should not be requested at load time.)

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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__(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager) → str
__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, : pyrosetta.rosetta.basic.resource_manager.ResourceManager) → pyrosetta.rosetta.basic.resource_manager.ResourceManager

C++: basic::resource_manager::ResourceManager::operator=(const class basic::resource_manager::ResourceManager &) –> class basic::resource_manager::ResourceManager &

clear(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager) → None
wipe out all data; useful for unit testing, but hard to
fathom how it would be useful otherwise.

C++: basic::resource_manager::ResourceManager::clear() –> void

get_instance() → pyrosetta.rosetta.basic.resource_manager.ResourceManager
Deprecated access to a global (not-quite singleton) ResourceManager instance that
should be removed

C++: basic::resource_manager::ResourceManager::get_instance() –> class basic::resource_manager::ResourceManager *

get_option(*args, **kwargs)

Overloaded function.

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> bool

Retrieve the boolean value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::BooleanOptionKey) const –> bool

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_bool

Retrieve the vector of boolean values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::BooleanVectorOptionKey) const –> const class utility::vector1<bool, class std::allocator<bool> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> pyrosetta.rosetta.utility.file.FileName

Retrieve the FileName value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::FileOptionKey) const –> const class utility::file::FileName &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_utility_file_FileName

Retrieve the vector of FileName values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::FileVectorOptionKey) const –> const class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> int

Retrieve the integer value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::IntegerOptionKey) const –> int

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_int

Retrieve the vector of integer values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::IntegerVectorOptionKey) const –> const class utility::vector1<int, class std::allocator<int> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> pyrosetta.rosetta.utility.file.PathName

Retrieve the PathName value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::PathOptionKey) const –> const class utility::file::PathName &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_utility_file_PathName

Retrieve the vector of PathName values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::PathVectorOptionKey) const –> const class utility::vector1<class utility::file::PathName, class std::allocator<class utility::file::PathName> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> float

Retrieve the Real value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::RealOptionKey) const –> double

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_double

Retrieve the vector of Real values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::RealVectorOptionKey) const –> const class utility::vector1<double, class std::allocator<double> > &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> str

Retrieve the string value represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::StringOptionKey) const –> const std::string &

  1. get_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> pyrosetta.rosetta.utility.vector1_std_string

Retrieve the vector of string values represented by the given option key

C++: basic::resource_manager::ResourceManager::get_option(class utility::options::StringVectorOptionKey) const –> const class utility::vector1<std::string, class std::allocator<std::string > > &

has_option(*args, **kwargs)

Overloaded function.

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::BooleanOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::BooleanVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::FileOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::FileVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::IntegerOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::IntegerVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::PathOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::PathVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::RealOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::RealVectorOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::StringOptionKey) const –> bool

  1. has_option(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> bool
Return whether or not a value has been provided for the given option key either
on the command line or through for the current job.

C++: basic::resource_manager::ResourceManager::has_option(class utility::options::StringVectorOptionKey) const –> bool

has_resource(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, resource_tag: str) → bool

Does a resource with a given name exist?

C++: basic::resource_manager::ResourceManager::has_resource(const class std::basic_string<char> &) const –> bool

has_resource_with_description(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, resource_description: str) → bool
A protocol may ask whether a resource with a given resource description
has been provided. It is possible that some resources are available sometimes when running a protocol, but not always (e.g. when running abinitio, sometimes you don’t know what the native structure is).

C++: basic::resource_manager::ResourceManager::has_resource_with_description(const class std::basic_string<char> &) –> bool

show(self: pyrosetta.rosetta.basic.resource_manager.ResourceManager, out: pyrosetta.rosetta.std.ostream) → None

C++: basic::resource_manager::ResourceManager::show(class std::basic_ostream<char> &) const –> void

class pyrosetta.rosetta.basic.resource_manager.ResourceManagerCreator

Bases: pybind11_builtins.pybind11_object

Derived classes will be used by the ResourceManagerFactory to decide which of the various ResourceManagers should be instantiated. The ResourceManager is a singleton, but, different ResourceManagers can be instantiated in different contexts.

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceManagerCreator, : pyrosetta.rosetta.basic.resource_manager.ResourceManagerCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceManagerCreator

C++: basic::resource_manager::ResourceManagerCreator::operator=(const class basic::resource_manager::ResourceManagerCreator &) –> class basic::resource_manager::ResourceManagerCreator &

class pyrosetta.rosetta.basic.resource_manager.ResourceManagerFactory

Bases: pyrosetta.rosetta.utility.SingletonBase_basic_resource_manager_ResourceManagerFactory_t

A factory class for managing the instantiation of the singleton ResourceManager: only one of the various derived classes will be instantiated. Currently, it asks for the JD2ResourceManager; in the future, this should be fixed so that it reads from the options system to figure out which ResourceManager to instantiate.

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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).

create_resource_manager_from_options_system(self: pyrosetta.rosetta.basic.resource_manager.ResourceManagerFactory) → pyrosetta.rosetta.basic.resource_manager.ResourceManager

Should only be called by the ResourceManager in its singleton construction!

C++: basic::resource_manager::ResourceManagerFactory::create_resource_manager_from_options_system() const –> class basic::resource_manager::ResourceManager *

factory_register(self: pyrosetta.rosetta.basic.resource_manager.ResourceManagerFactory, creator: pyrosetta.rosetta.basic.resource_manager.ResourceManagerCreator) → None

C++: basic::resource_manager::ResourceManagerFactory::factory_register(class std::shared_ptr<class basic::resource_manager::ResourceManagerCreator>) –> void

get_instance() → basic::resource_manager::ResourceManagerFactory

C++: utility::SingletonBase<basic::resource_manager::ResourceManagerFactory>::get_instance() –> class basic::resource_manager::ResourceManagerFactory *

class pyrosetta.rosetta.basic.resource_manager.ResourceOptions

Bases: pybind11_builtins.pybind11_object

The %ResourceOptions class is responsible for describing all the data requried for instanting a particular resource, except for the data stream (i.e. the file) that contains the data for the resource. For example, when reading in a PDB file, there are 30 different options for how that PDB file should be turned into a Pose. That data is now held in an ImportPoseOptions object. The purpose of the %ResourceOptions class is to allow different jobs to load resources in different ways, or for one job to load two different resources of the same type in different ways. For example, a protocol may need both a centroid pose and a fullatom pose to be loaded in from disk; however, if the logic for loading a pose in from disk is controlled by the options system alone, this becomes impossible.

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions, name: str) -> None
  3. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions, arg0: pyrosetta.rosetta.basic.resource_manager.ResourceOptions) -> None
__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.

__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__(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions) → str
__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions, : pyrosetta.rosetta.basic.resource_manager.ResourceOptions) → pyrosetta.rosetta.basic.resource_manager.ResourceOptions

C++: basic::resource_manager::ResourceOptions::operator=(const class basic::resource_manager::ResourceOptions &) –> class basic::resource_manager::ResourceOptions &

name(*args, **kwargs)

Overloaded function.

  1. name(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions) -> str
A name given to a particular ResourceOptions instance.
This function allows for better error message delivery.

C++: basic::resource_manager::ResourceOptions::name() const –> std::string

  1. name(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions, setting: str) -> None

Set the name for this %ResoureOptions instance.

C++: basic::resource_manager::ResourceOptions::name(const class std::basic_string<char> &) –> void

parse_my_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions, tag: utility::tag::Tag) → None

Initialize from the recursive “tag” structure.

C++: basic::resource_manager::ResourceOptions::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions, out: pyrosetta.rosetta.std.ostream) → None

Describe this instance to a given output stream

C++: basic::resource_manager::ResourceOptions::show(class std::basic_ostream<char> &) const –> void

type(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptions) → str
The class name (its type) for a particular ResourceOptions instance.
This function allows for better error message delivery.

C++: basic::resource_manager::ResourceOptions::type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator

Bases: pybind11_builtins.pybind11_object

Each derived %ResourceOptionsCreator class is responsible for instantiating a (specific) derived ResourceOptions class, and for telling the ResourceOptionsFactory the string which identifies that class. There should be one derived ResourceOptionsCreator class for each ResourceOptions class.

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator, arg0: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator) -> None
__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator, : pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator

C++: basic::resource_manager::ResourceOptionsCreator::operator=(const class basic::resource_manager::ResourceOptionsCreator &) –> class basic::resource_manager::ResourceOptionsCreator &

create_options(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceOptions

C++: basic::resource_manager::ResourceOptionsCreator::create_options() const –> class std::shared_ptr<class basic::resource_manager::ResourceOptions>

options_type(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator) → str

C++: basic::resource_manager::ResourceOptionsCreator::options_type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.ResourceOptionsFactory

Bases: pyrosetta.rosetta.utility.SingletonBase_basic_resource_manager_ResourceOptionsFactory_t

The %ResourceOptionsFactory class is responsible for maintaining the map between the names of the ResourceOptions classes (strings) and the ResourceOptionsCreator classes that are responsible for instantiating the ResourceOption classes. This is a singleton class. It is initialized at load time – or at least after the call to devel::init( argc, argv ) – and populated with the help of ResourceOptionsRegistrator instances.

__delattr__

Implement delattr(self, name).

__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__

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

__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.

__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).

create_resource_options(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsFactory, options_type: str, tag: utility::tag::Tag) → pyrosetta.rosetta.basic.resource_manager.ResourceOptions
Create an instance of a ResourceOptions class given the name of the class
(options_type) and initialize it from the given tag object. Throws an EXCN_Msg_Exception exception if the options_type string is not recognized.

C++: basic::resource_manager::ResourceOptionsFactory::create_resource_options(const class std::basic_string<char> &, class std::shared_ptr<const class utility::tag::Tag>) const –> class std::shared_ptr<class basic::resource_manager::ResourceOptions>

factory_register(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsFactory, creator: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsCreator) → None
Register the given ResourceOptionsCreator object with the factory. Invoked by an
instance of the templated ResourceOptionsRegistrator class.

C++: basic::resource_manager::ResourceOptionsFactory::factory_register(class std::shared_ptr<class basic::resource_manager::ResourceOptionsCreator>) –> void

get_instance() → basic::resource_manager::ResourceOptionsFactory

C++: utility::SingletonBase<basic::resource_manager::ResourceOptionsFactory>::get_instance() –> class basic::resource_manager::ResourceOptionsFactory *

set_throw_on_double_registration(self: pyrosetta.rosetta.basic.resource_manager.ResourceOptionsFactory) → None
Instruct the %ResourceOptionsFactory to throw an exception if two ResourceOptionCreators
are registered with the factory that report the same “options_type” string instead of invoking utility_exit_with_message.

C++: basic::resource_manager::ResourceOptionsFactory::set_throw_on_double_registration() –> void

class pyrosetta.rosetta.basic.resource_manager.ResourceStream

Bases: pybind11_builtins.pybind11_object

The %ResourceStream represents an abstract class for packaging up a standard istream so that data that the ResourceLocator needs to deliver to a ResourceLoader can come from arbitrary sources (e.g. from either a file or from a database).

__delattr__

Implement delattr(self, name).

__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__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceStream) -> None
  2. __init__(self: pyrosetta.rosetta.basic.resource_manager.ResourceStream, arg0: pyrosetta.rosetta.basic.resource_manager.ResourceStream) -> None
__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.

__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).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceStream, : pyrosetta.rosetta.basic.resource_manager.ResourceStream) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

C++: basic::resource_manager::ResourceStream::operator=(const class basic::resource_manager::ResourceStream &) –> class basic::resource_manager::ResourceStream &

stream(self: pyrosetta.rosetta.basic.resource_manager.ResourceStream) → pyrosetta.rosetta.std.istream
Return an istream reference so that the ResourceLoader can access arbitrary data
returned by the %ResourceLocator

C++: basic::resource_manager::ResourceStream::stream() –> class std::basic_istream<char> &