regularize
index
regularize.py


Functions to modify atomic coordinates such that covalent restraints (bond,
angle, improper) are satisfied. 

 
Classes
       
exceptions.Exception(exceptions.BaseException)
CovalentViolation

 
class CovalentViolation(exceptions.Exception)
    
Method resolution order:
CovalentViolation
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods defined here:
__init__(s, mess)

Data and other attributes defined here:
__weakref__ = <attribute '__weakref__' of 'CovalentViolation' objects>
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object at 0x2b909a52ce00>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
               
               Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)

Data and other attributes inherited from exceptions.BaseException:
__dict__ = <dictproxy object at 0xed9830>
args = <attribute 'args' of 'exceptions.BaseException' objects>
message = <member 'message' of 'exceptions.BaseException' objects>
exception message

 
Functions
       
addUnknownAtoms(dyn_stepsize=0.02, dyn_numStepMul=1, verbose=0, simulation=0)
add in unknown atoms so that covalent and vdw terms are satisfied.
    This routine is slow, but it is rather robust.
 
    dyn_stepsize specifies the timestep size during the MD phase. Reduce this
    if you have convergence problems.
 
    dyn_numStepMul is a multiplier for the number of molecular dynamics steps
    taken. Increase this to get better convergence.
 
    if verbose=True, details of the minimization procedure are printed.
 
    
addUnknownAtoms_fast(verbose=0, maxFixupIters=500, simulation=0)
add in unknown atoms so that covalent and vdw terms are satisfied by
    randomly placing atoms, and calling protocol.fixupCovalentGeom() to
    correct the covalent geometry, using maxFixupIters as the maxIters
    argument to that function.
 
    This is a fast version which will only reliably work if the missing atoms
    are separated by a single bond from a known atom.
 
    if verbose=True, details of the minimization procedure are printed.
 
    
covalentMinimize(sel=0, numSteps=100, dEpred=1.0)
perform gradient optimization including only covalent terms (bonds,
    angles, impropers)
    
fixupCovalentGeom(sel=0, useVDW=0, useDynamics=1, dynRatio=5, maxIters=40, verbose=0, maxViols=0, bondTol=0.01, angleTol=2.0, torsionTol=2.0, extraTerms=[])
given the atoms in selection sel, perform, minimization and (optionally)
    dynamics to remove bond, angle, and improper violations - so that there
    total number is less than or equal to maxViols.
 
    If useVDW is set, the nonbonded term will be used 1/4 of the time.
    if useDynamics is set, dynamics will be used 1/dynRatio of the time.
    maxIters is the total maximum number of iterations.
 
    tolerances for bond, bond angle and improper torsion angles can also be
    specified using optional arguments.
 
    additional terms to satify may be specified with the extraTerms
    argument. Terms should be specified as a tuple of (pot,tol), where
    pot is a pot.Pot term and tol is the desired tolerance to be
    obtained. 
 
    If this function is not successful in satisfying all covalent restraints,
    it will throw the exception protocol.CovalentViolation.
 
    This function changes the XPLOR constraints settings.
 
    If verbose>0, intermediate status is printed. Increase verbose for more
    verbosity.