Binary installation

Binary installation is strongly recommended for new users of IMP. It is much faster than building from source code, requires a smaller download, and all the necessary prerequisites are handled for you automatically.

We recommend you use a stable release. These are available for Windows, Mac and Linux from our download page.

Binaries are also available for our latest nightly builds. If you do decide to use a nightly build, please check out the nightly builds results page to see if the code is currently stable enough for your purposes.

Source code installation

Prerequisites

In order to build IMP from source, you will need:

A C++ compiler that supports the C++11 standard, such as gcc, clang, or Microsoft Visual Studio 2012 or later.
CMake (2.8.12 or later; 3.14 or later is recommended)
Boost (1.53 or later; Boost.Iostreams must be built with its zlib filter enabled)
Eigen (3.0 or later)
HDF5 (1.8 or later; 1.10 or 1.12 should also work)
Python (2.7 or later, or any version of Python 3)
SWIG (3 or later)

The following prerequisites are optional; without them some parts of IMP will not build, and some will not function optimally.

The NumPy library is strongly recommended; if IMP is built with NumPy, many operations that transfer data between C++ and Python become more efficient.
Doxygen (only exactly version 1.8.6 is supported) and Graphviz: required for building documentation.
Modeller: needed to use the IMP.modeller module.
CGAL: enables faster geometric operations, such as nonbonded lists.
Google perf tools: needed only for profiling IMP code.
ANN: certain data structures will be faster if it is available.
GSL (1.13 or later): needed to use the IMP.gsl module.
OpenCV (2.1 or later): needed to use the IMP.em2d module or the idock and emagefit command line tools.
FFTW: needed to use the IMP.em2d or IMP.multifit modules or the multifit command line tool.
libTAU: needed to use the IMP.cnmultifit module or the cnmultifit command line tool.
Protobuf: needed to use the IMP.npctransport module.
An MPI library is needed to use the IMP.mpi module.
The scipy, scikit-learn, and matplotlib Python libraries are also recommended.
Chimera or ChimeraX are recommended for visualization of results.

The following prerequisites are bundled, i.e. they are included with IMP itself and will be built at the same time as IMP, unless explicitly requested otherwise (see CMake for more information):

RMF (1.3 or later) for handling RMF files, and the IMP.rmf module.
python-ihm for handling mmCIF and BinaryCIF files.

(Note that if you build a stable release of IMP from source code, using versions of dependencies that were released after that IMP release (e.g. a brand new version of Python), you may run into build issues. Either use older versions of the dependencies, or look at the patches we've applied to the conda package and apply them to your source code checkout.)

Getting prerequisites on Linux

All of the prerequisites should be available as pre-built packages for your Linux distribution of choice. For example, on a Fedora system the following should install most of the prerequisites:

    sudo dnf install boost-devel gperftools-devel CGAL-devel graphviz gsl-devel cmake hdf5-devel swig fftw-devel opencv-devel python3-numpy

Getting prerequisites on a Mac

Mac users must first install the developer Command Line Tools, which can be done from the command line by running

    sudo xcode-select --install

These can also be obtained by installing Xcode from the App store, then trying to run a command line tool (such as clang) which will prompt to install the tools.

Then Mac users should use one of the available collections of Unix tools, such as

Homebrew (recommended) Once you installed homebrew do
```
  brew tap salilab/salilab
  brew install boost gmp google-perftools cgal graphviz gsl cmake hdf5 swig fftw mpfr opencv libtau eigen
```
to install everything IMP finds useful (or that you will want for installing various useful Python libs that IMP finds useful). On older Macs, you may also need to brew install git if you want to use git (newer Macs include git).
Macports If you use MacPorts, you must verify /opt/local/bin is in your path (this may be taken care of by MacPorts automatically, and can be done manually either by modifying your shell's config file or by making an environment.plist file), and then do
```
  sudo port install boost cgal cmake fftw gmp gperftools graphviz gsl eigen hdf5 mpfr ninja opencv protobuf-cpp swig swig-python  
```
(as in brew, some of these packages may be optional)
or Fink (not supported)

Getting prerequisites on Windows

We recommend Linux or Mac for developing with IMP, as obtaining the prerequisites on Windows is much more involved. However, if you really want to build on Windows, see the building from source code on Windows page for the procedure we use.

Download

Download the source code tarball from our download page, then extract it with something like:
```
  tar -xvzf ../imp-<version>.tar.gz
```
Alternatively you can use git to get the code directly from our GitHub repository with something like:
```
  git clone -b main https://github.com/salilab/imp.git
  (cd imp && git submodule update --init && ./setup_git.py)
```
(the main branch tracks the most recent stable release; alternatively you can use develop to get the most recent code, but please check out the nightly builds results page to see if the code is currently stable enough for your purposes).

Compilation

Make a separate directory to keep the compiled version of IMP in (it's tidier to keep this separate from the source code, and if you need to later you can just delete this directory without affecting the source). Set up the build with CMake, then finally compile it, with something like:

mkdir imp_release
cd imp_release
cmake <path to IMP source>
make -j8

There are a number of ways in which IMP can be configured. See the configuration options page for more details and for help with CMake problems.

Testing

Once the compilation is complete, you can optionally run the test suite. Test are run using ctest. A good start is to run ctest --output-on-failure.

Tests are labeled with the module name and the type and cost of the test, so to run just the expensive tests in the atom module, use ctest -L "^IMP\.atom\-test\-.*EXPENSIVE".

Benchmarks are simply tests labeled as benchmark; examples are tests labeled as example.

Note that some test failures are to be expected; compare the failures with those at our own nightly builds page if you are concerned.

Installation

Once everything is compiled (and optionally tested) you can install IMP by simply running make install. If you opted to install in a non-standard location, it is up to you to set up your environment variables so that IMP can be found (you may need to set PATH, PYTHONPATH, and LD_LIBRARY_PATH).

Alternatively, you can run IMP directly from the build directory by using the setup_environment.sh script. This sets the necessary environment variables and then runs the rest of the command line with this modified environment. For example, to run the ligand_score command line tool you can either run

./setup_environment.sh ligand_score <arguments>

or create a new shell with

./setup_environment.sh $SHELL

and then run

ligand_score <arguments>

in that shell.

Table of Contents