IMP::modeller Namespace Reference

Interface to the Modeller comparative modeling package. More...

Detailed Description

Interface to the Modeller comparative modeling package.

Functionality includes:

• Loading a Modeller model into IMP
• Calling the Modeller scoring function from IMP
• Calling the IMP scoring function from Modeller
• Converting a set of Modeller static restraints or dynamic restraints into equivalent IMP restraints

Modeller

If you want to use IMP with MODELLER, you should use version 9v7 or later. If you installed the MODELLER Linux RPM or Mac package, it should be detected automatically. Make sure that MODELLER is found in your PYTHONPATH.

Info

Author(s): Ben Webb, Daniel Russel

Maintainer: benmwebb

License: LGPL This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Publications:

• See main IMP papers list.

Classes
class	BinormalTerm
	A single binormal term in a MultipleBinormalRestraint. More...
class	IMPRestraints
	A Modeller restraint which evaluates an IMP scoring function. More...
class	ModellerRestraints
	An IMP restraint using all defined Modeller restraints. More...
class	ModelLoader
	Read a Modeller model into IMP. More...
class	MultipleBinormalRestraint
	Modeller-style multiple binormal (phi/psi) restraint. More...

Typedefs
typedef IMP::Vector< BinormalTerm >	BinormalTermList

Functions
def	add_soft_sphere_radii
	Add radii to the hierarchy using the Modeller radius library, radii.lib. More...
def	load_restraints_file
	Convert a Modeller restraints file into IMP::Restraint objects. More...
def	read_pdb
	Construct an IMP::atom::Hierarchy from a PDB file. More...

Standard module functions
All IMP modules have a set of standard functions to help get information about the module and about files associated with the module.
std::string	get_module_version ()
std::string	get_module_name ()
std::string	get_data_path (std::string file_name)
	Return the full path to one of this module's data files. More...
std::string	get_example_path (std::string file_name)
	Return the full path to one of this module's example files. More...

Typedef Documentation

typedef IMP::Vector< BinormalTerm > IMP::modeller::BinormalTermList

Pass or store a set of BinormalTerm .

Definition at line 85 of file MultipleBinormalRestraint.h.

Function Documentation

def IMP.modeller.add_soft_sphere_radii	(		hierarchy,
			submodel,
			scale = 1.0,
			filename = None
	)

Add radii to the hierarchy using the Modeller radius library, radii.lib.

Each radius is scaled by the given scale (Modeller usually scales radii by a factor of 0.82). submodel specifies the topology submodel, which is the column in radii.lib to use.

Note

This function is only available in Python.

Definition at line 847 of file modeller/__init__.py.

std::string IMP::modeller::get_data_path

(

std::string

file_name

)

Return the full path to one of this module's data files.

To read the data file "data_library" that was placed in the data directory of this module, do something like

std::ifstream in(IMP::modeller::get_data_path("data_library"));

This will ensure that the code works both when IMP is installed or if used via the setup_environment.sh script.

Note

Each module has its own data directory, so be sure to use this function from the correct module.

std::string IMP::modeller::get_example_path

(

std::string

file_name

)

Return the full path to one of this module's example files.

To read the example file "example_protein.pdb" that was placed in the examples directory of this module, do something like

std::ifstream in(IMP::modeller::get_example_path("example_protein.pdb"));

This will ensure that the code works both when IMP is installed or if used via the setup_environment.sh script.

Note

Each module has its own example directory, so be sure to use this function from the correct module.

def IMP.modeller.load_restraints_file	(		filename,
			protein
	)

Convert a Modeller restraints file into IMP::Restraint objects.

Parameters

filename	Name of the Modeller restraints file.
protein	An IMP::atom::Hierarchy containing the protein atoms (e.g. as returned by read_pdb). The Modeller restraints file is assumed to act on the same PDB described by protein.

Returns

A Python list of the newly-created IMP::Restraint objects.

Deprecated:

As of IMP release 2.5. See the IMP Deprecation Policy for more information about deprecation in IMP. Use ModelLoader instead.

Note

This function is only available in Python.

Definition at line 790 of file modeller/__init__.py.

def IMP.modeller.read_pdb	(		name,
			model,
			special_patches = None
	)

Construct an IMP::atom::Hierarchy from a PDB file.

Parameters

name	The name of the PDB file to read.
model	The IMP::Model object in which the hierarchy will be created. The highest level hierarchy node is a PROTEIN.
special_patches	If given, a function that applies patches (e.g. nucleic acid termini) to the Modeller model.

Returns

the newly-created root IMP::atom::Hierarchy.

Deprecated:

As of IMP release 2.5. See the IMP Deprecation Policy for more information about deprecation in IMP. Use IMP::atom::read_pdb() instead to read a PDB file, or ModelLoader to read a Modeller model.

Note

This function is only available in Python.

Definition at line 1110 of file modeller/__init__.py.