ost.bindings.tmtools Namespace Reference

Data Structures
class	MMAlignResult
class	TMScoreResult

Functions
def	TMAlign
def	MMAlign
def	TMScore

Function Documentation

def ost.bindings.tmtools.MMAlign	(		model1,
			model2,
			mmalign = None
	)

Run tmalign on two protein structures

Definition at line 241 of file tmtools.py.

def ost.bindings.tmtools.TMAlign	(		model1,
			model2,
			tmalign = None
	)

Performs a sequence independent superposition of model1 onto model2, the 
reference.


:param model1: The model structure. If the superposition is successful, will 
               be superposed onto the reference structure
:type model1: :class:`~ost.mol.EntityView` or :class:`~ost.mol.EntityHandle`
:param model2: The reference structure
:type model2: :class:`~ost.mol.EntityView` or :class:`~ost.mol.EntityHandle`
:param tmalign: If not None, the path to the tmalign executable.
:returns: The result of the tmscore superposition
:rtype: :class:`ost.bindings.TMAlignResult`

:raises: :class:`~ost.settings.FileNotFound` if tmalign could not be located.
:raises: :class:`RuntimeError` if the superposition failed

Definition at line 217 of file tmtools.py.

def ost.bindings.tmtools.TMScore	(		model1,
			model2,
			tmscore = None
	)

Performs a sequence dependent superposition of model1 onto model2, 
the reference.

:param model1: The model structure. If the superposition is successful, will 
               be superposed onto the reference structure
:type model1: :class:`~ost.mol.EntityView` or :class:`~ost.mol.EntityHandle`
:param model2: The reference structure
:type model2: :class:`~ost.mol.EntityView` or :class:`~ost.mol.EntityHandle`
:param tmscore: If not None, the path to the tmscore executable.
:returns: The result of the tmscore superposition
:rtype: :class:`TMScoreResult`

:raises: :class:`~ost.settings.FileNotFound` if tmalign could not be located.
:raises: :class:`RuntimeError` if the superposition failed

Definition at line 251 of file tmtools.py.