IMP::module_template Namespace Reference

Template for a module that is stored externally to IMP. More...

Detailed Description

Template for a module that is stored externally to IMP.

To use this template, clone to a new location or fork it on github. To set the name, name the repository and, for the time being, change the name in the .imp_info.py file. The module has format checks enabled.

Info

Author(s):

Maintainer:

License: None

Publications:

• None

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 installed data. More...
std::string	get_example_path (std::string file_name)
	Return the path to installed example data for this module. More...

Function Documentation

std::string IMP::module_template::get_data_path

(

std::string

file_name

)

Return the full path to installed data.

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 setup_environment.sh script.

std::string IMP::module_template::get_example_path

(

std::string

file_name

)

Return the path to installed example data for this module.

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 setup_environment.sh script.