IMP::system Namespace Reference

See IMP.system Overview for more information.

Functions
def	get_data_input_path
	Get the path where the current script should find data files.
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...
def	get_input_path
	Get the path where the current script should find output of the last script.
def	get_is_test
	Return whether this run is called with –test. More...
def	get_output_path
	Get the path to where the current script should write output files.
def	get_sample_parameters
	Return the index and the number of parts to divide the job in to. 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::system::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::system::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.

def IMP.system.get_is_test

(

)

Scripts that use this can't don't expect -j and -n and so an error will be thrown if they are passed.

Definition at line 8 of file system/__init__.py.

def IMP.system.get_sample_parameters

(

)

Definition at line 2 of file system/__init__.py.