IMP Manual

This manual covers the installation of the Integrative Modeling Platform (IMP) software and its basic usage. It is targeted mainly at users, i.e. people that want to use existing IMP functionality. Later sections of this manual introduce more technical details to those that want to modify the IMP source code to develop new methods (developers). The Reference Guide may also be useful for such developers.

Users that want to get started quickly with modeling a real biological complex might want to skip ahead to Modeling of complexes using IMP::pmi.

Note

This documentation is for version 20241220.develop.633b6aeaec (a nightly build) of IMP. For documentation for other versions, please see the documentation page at the IMP website.

• Installation
• Introduction to integrative modeling
• Design of IMP
• Chimera(X) tools and web services
• Using command line tools
  • FoXS: fitting structures against SAXS data
  • MultiFoXS: determination of multi-state models
  • Integrative docking: combining experimental data with computational pairwise docking
  • Conformational sampling: sampling antibody conformations using the rapidly exploring random tree (RRT) algorithm
  • EMageFit: solution of a complex structure using subunit structures and EM class averages
  • MultiFit: solution of a complex structure using subunit structures and a cryo-EM density map
  • CNMultiFit: solution of symmetric complexes using a cryo-EM density map
  • SAXSMerge: merging multiple SAXS profiles
• Modeling of complexes using IMP::pmi
• The IMP C++/Python library
  • Overview
  • Example of using the library
  • Glossary
  • Logging
  • Runtime checks
  • Units
  • Naming and interface conventions
  • Parallelization
  • Using the library in other projects
  • Building modules out of tree
• Frequently asked questions (FAQ)
• Contributing to IMP
• Bug reports
• GPU support
• Applying IMP to a new biological system
• Developing the IMP source code
  • Developer setup
  • Directory structure
  • Coding conventions
  • Good programming practices
  • IMP gotchas
  • Writing new code
  • Working with source control
  • Adding external dependencies
  • Python-only modules
  • Design example
  • Tools for developers
  • Documenting your code
  • Debugging and testing your code
  • Writing examples
  • Exporting C++ code to Python
  • Serialization
  • Code coverage
  • Profiling your code
  • Deprecation
  • Cross platform compatibility
  • Contributing code back to IMP
  • Supporting your code
  • Automated builds and checks
• Internals
  • Dependencies
  • Evaluation
  • Close pairs lists
  • RMF
  • Building
  • git submodules and subtrees
• Copyright and licenses
• Change history
• Code of conduct
• Publications