IMP  2.0.1
The Integrative Modeling Platform
IMP::parallel Namespace Reference

See IMP.parallel Overview for more information.

Classes

class  Context
 A collection of tasks that run in the same environment. More...
 
class  Error
 Base class for all errors specific to the parallel module. More...
 
class  LocalSlave
 A slave running on the same machine as the master. More...
 
class  Manager
 Manages slaves and contexts. More...
 
class  NetworkError
 Error raised if a problem occurs with the network. More...
 
class  NoMoreSlavesError
 Error raised if all slaves failed, so tasks cannot be run. More...
 
class  RemoteError
 Error raised if a slave has an unhandled exception. More...
 
class  SGEPESlaveArray
 An array of slaves in a Sun Grid Engine system parallel environment. More...
 
class  SGEQsubSlaveArray
 An array of slaves on a Sun Grid Engine system, started with 'qsub'. More...
 
class  Slave
 Representation of a single slave. More...
 
class  SlaveArray
 Representation of an array of slaves. More...
 

Functions

std::string get_data_path (std::string file_name)
 Return the full path to installed data. More...
 
std::string get_example_path (std::string file_name)
 Return the path to installed example data for this module. More...
 

Standard module methods

All IMP modules have a set of standard methods to help get information about the module and about files associated with the module.

std::string get_module_version ()
 
std::string get_module_name ()
 

Function Documentation

std::string IMP::parallel::get_data_path ( std::string  file_name)

Each module has its own data directory, so be sure to use the version of this function in the correct module. To read the data file "data_library" that was placed in the data directory of module "mymodule", do something like

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

This will ensure that the code works when IMP is installed or used via the tools/imppy.sh script.

std::string IMP::parallel::get_example_path ( std::string  file_name)

Each module has its own example directory, so be sure to use the version of this function in the correct module. For example to read the file example_protein.pdb located in the examples directory of the IMP::atom module, do

IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb", model));

This will ensure that the code works when IMP is installed or used via the tools/imppy.sh script.