Rosetta
Namespaces | Classes | Functions | Variables
pyrosetta Namespace Reference

Namespaces

 bindings
 
 distributed
 
 io
 
 logging_support
 
 mpi
 
 network
 
 numeric
 
 protocols
 
 PyMOLRosettaServer
 
 teaching
 
 tests
 
 toolbox
 
 utility
 

Classes

class  PyRosettaException
 Exception handling. More...
 
class  PythonPyExitCallback
 
class  EnergyMethod
 

Functions

def _rosetta_database_from_env ()
 
def _is_interactive ()
 
def init (options='-ex1 -ex2aro', extra_options='', set_logging_handler=None, notebook=None, silent=False)
 
def _version_string ()
 
def version ()
 
def _vector_extend_func (vec, othervec)
 Vector compatibility: Adding 'extend' to all utility.vector* functions. More...
 
def Vector1 (list_in)
 
def Set (list_in)
 
def generate_nonstandard_residue_set (pose, params_list)
 New methods. More...
 
def standard_task_factory ()
 
def standard_packer_task (pose)
 
def defineEnergyMethodCreator (class_, scoreType)
 

Variables

 vector1_string
 
 list_std_shared_ptr_core_pack_task_operation_TaskOperation_std_allocator_std_shared_ptr_core_pack_task_operation_TaskOperation_t
 
 vector_std_vector_double_std_allocator_double_t
 
 set_std_string_std_less_std_string_std_allocator_std_string_t
 
 logger = logging.getLogger("pyrosetta.rosetta")
 
 extend
 
list _mem_EnergyMethods_ = []
 Decorator generation for custom PyRosetta energy methods. More...
 
list _mem_EnergyCreators_ = []
 
 CD = namedtuple("CD", "base first last methods")
 
list _ScoreTypesRegistryByType_
 
dictionary ScoreTypesRegistry = {}
 

Function Documentation

◆ _is_interactive()

def pyrosetta._is_interactive ( )
private
Determine if in an interactive context.

See: https://stackoverflow.com/questions/2356399/tell-if-python-is-in-interactive-mode

Referenced by init(), and pyrosetta.distributed.maybe_init().

◆ _rosetta_database_from_env()

def pyrosetta._rosetta_database_from_env ( )
private
Read rosetta database directory from environment or standard install locations.

Database resolution proceeds by first searching the current installation for a 'database' or 'rosetta_database'
path. If not found the search then continues to the users's home dir, cygwin, and osx standard installation
locations.

Returns database path if found, else None.

Referenced by init().

◆ _vector_extend_func()

def pyrosetta._vector_extend_func (   vec,
  othervec 
)
private

Vector compatibility: Adding 'extend' to all utility.vector* functions.

◆ _version_string()

def pyrosetta._version_string ( )
private

◆ defineEnergyMethodCreator()

def pyrosetta.defineEnergyMethodCreator (   class_,
  scoreType 
)

◆ generate_nonstandard_residue_set()

def pyrosetta.generate_nonstandard_residue_set (   pose,
  params_list 
)

New methods.

Places the ResidueTypes corresponding to a list of .params filenames into a given pose

.params files must be generated beforehand. Typically, one would obtain a
molfile (.mdl) generated from the xyz coordinates of a residue, small
molecule, or ion.  The script molfile_to_params.py can be used to convert
to a Rosetta-readable .params file.  It can be found in the /test/tools
folder of your PyRosetta installation or downloaded from the Rosetta
Commons.

Example:
    params = ["penicillin.params", "amoxicillin.params"]
    pose = Pose()
    generate_nonstandard_residue_set(pose, params)
    pose_from_file(pose, "TEM-1_with_substrates.pdb")
See also:
    ResidueTypeSet
    Vector1()
    pose_from_file()

References Vector1().

◆ init()

def pyrosetta.init (   options = '-ex1 -ex2aro',
  extra_options = '',
  set_logging_handler = None,
  notebook = None,
  silent = False 
)
Initialize Rosetta.  Includes core data and global options.

options string with default Rosetta command-line options args.
        (default: '-ex1 -ex2aro')
kwargs -
    extra_options - Extra command line options to pass rosetta init.
                    (default None)
    set_logging_handler - Route rosetta tracing through logging logger 'rosetta':
        None - Set handler if interactive, otherwise not.
        False - Write logs via c++-level filehandles.
        "interactive" - Register python log handling and make visible if not.
        "logging" - Register python log handling, do not update logging config.
        True - Register python log handling, make visible if logging isn't configured.

Examples:
    init()                     # uses default flags
    init(extra_options='-pH')  # adds flags to supplement the default
    init('-pH -database /home/me/pyrosetta/rosetta_database')  # overrides default flags - be sure to include the dB last

References _is_interactive(), _rosetta_database_from_env(), pyrosetta.protocols.h5_fragment_store_provider.init_H5FragmentStoreProvider(), pyrosetta.protocols.h5_structure_store_provider.init_H5StructureStoreProvider(), print(), and version().

Referenced by pyrosetta.toolbox.load_ligand.add_cid_to_database(), pyrosetta.tests.distributed.cluster.skip_cloudpickle_version.main(), pyrosetta.distributed.maybe_init(), pyrosetta.mpi.mpi_init(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.setUpClass(), test.T010_LoadPDB.LoadPDBTest.setUpClass(), and test.T300_PyJobDistributor.TestPyJobDistributor.setUpClass().

◆ Set()

def pyrosetta.Set (   list_in)
Creates a std::set object, deducing type from the given list.

References all, str(), and predPRE.t.

Referenced by operator>>().

◆ standard_packer_task()

def pyrosetta.standard_packer_task (   pose)

◆ standard_task_factory()

def pyrosetta.standard_task_factory ( )

◆ Vector1()

def pyrosetta.Vector1 (   list_in)

◆ version()

def pyrosetta.version ( )

Variable Documentation

◆ _mem_EnergyCreators_

list pyrosetta._mem_EnergyCreators_ = []
private

◆ _mem_EnergyMethods_

list pyrosetta._mem_EnergyMethods_ = []
private

Decorator generation for custom PyRosetta energy methods.

◆ _ScoreTypesRegistryByType_

list pyrosetta._ScoreTypesRegistryByType_
private
Initial value:
1 = [
2  CD(base=rosetta.core.scoring.methods.ContextIndependentTwoBodyEnergy,
3  first=rosetta.core.scoring.PyRosettaTwoBodyContextIndepenedentEnergy_first,
4  last=rosetta.core.scoring.PyRosettaTwoBodyContextIndepenedentEnergy_last,
5  methods={}),
6  CD(base=rosetta.core.scoring.methods.ContextDependentTwoBodyEnergy,
7  first=rosetta.core.scoring.PyRosettaTwoBodyContextDependentEnergy_first,
8  last=rosetta.core.scoring.PyRosettaTwoBodyContextDependentEnergy_last,
9  methods={}),
10  CD(base=None,
11  first=rosetta.core.scoring.PyRosettaEnergy_first,
12  last=rosetta.core.scoring.PyRosettaEnergy_last,
13  methods={}),
14 ]
CD
Definition: __init__.py:335

◆ CD

pyrosetta.CD = namedtuple("CD", "base first last methods")

◆ extend

pyrosetta.extend

◆ list_std_shared_ptr_core_pack_task_operation_TaskOperation_std_allocator_std_shared_ptr_core_pack_task_operation_TaskOperation_t

pyrosetta.list_std_shared_ptr_core_pack_task_operation_TaskOperation_std_allocator_std_shared_ptr_core_pack_task_operation_TaskOperation_t

◆ logger

pyrosetta.logger = logging.getLogger("pyrosetta.rosetta")

◆ ScoreTypesRegistry

dictionary pyrosetta.ScoreTypesRegistry = {}

◆ set_std_string_std_less_std_string_std_allocator_std_string_t

pyrosetta.set_std_string_std_less_std_string_std_allocator_std_string_t

◆ vector1_string

pyrosetta.vector1_string

◆ vector_std_vector_double_std_allocator_double_t

pyrosetta.vector_std_vector_double_std_allocator_double_t