IMP logo
IMP Manual  for IMP version 2.19.0
installation.md
1 Installation {#installation}
2 ============
3 
4 [TOC]
5 
6 # Binary installation {#installation_binary}
7 
8 Binary installation is strongly recommended for new users of %IMP. It is
9 much faster than building from source code, requires a smaller download,
10 and all the necessary prerequisites are handled for you automatically.
11 
12 We recommend you use a stable release. These are available for
13 Windows, Mac and Linux from our [download page](https://integrativemodeling.org/download.html#stable).
14 
15 Binaries are [also available for our latest nightly builds](https://integrativemodeling.org/download.html#develop). If you do decide to use a nightly build,
16 please check out the [nightly builds results page](https://integrativemodeling.org/nightly/results/)
17 to see if the code is currently stable enough for your purposes.
18 
19 # Google Colab {#installation_colab}
20 
21 To experiment with IMP on [Google Colaboratory](https://colab.research.google.com), use the following code snippet:
22 
23 \code{.unparsed}
24 !echo "deb https://integrativemodeling.org/latest/download $(lsb_release -cs)/" > /etc/apt/sources.list.d/salilab.list
25 !wget -O /etc/apt/trusted.gpg.d/salilab.asc https://salilab.org/~ben/pubkey256.asc
26 !apt update
27 !apt install imp
28 import sys
29 sys.path.append('/usr/lib/python3.8/dist-packages')
30 \endcode
31 
32 # Source code installation {#installation_source}
33 
34 ## Prerequisites {#installation_prereqs}
35 
36 In order to build %IMP from source, you will need:
37 
38 - A C++ compiler that supports the C++11 standard, such as gcc, clang,
39  or Microsoft Visual Studio 2015 or later.
40 - [CMake](https://cmake.org) (2.8.12 or later; 3.14 or later is recommended)
41 - [Boost](https://www.boost.org) (1.53 or later; Boost.Iostreams must be built
42  with its [zlib filter enabled](https://www.boost.org/doc/libs/1_67_0/libs/iostreams/doc/installation.html))
43 - [Eigen](https://eigen.tuxfamily.org/) (3.0 or later)
44 - [HDF5](https://support.hdfgroup.org/HDF5/) (1.8 or later)
45 - [cereal](https://uscilab.github.io/cereal/)
46 - [Python](https://www.python.org) (3.6 or later, or 2.7)
47 - [SWIG](https://www.swig.org/) (3 or later)
48 
49 The following prerequisites are _optional_; without them some parts of %IMP
50 will not build, and some will not function optimally.
51 
52 - The [NumPy](https://numpy.org/) library is strongly recommended; if %IMP
53  is built with NumPy, many operations that transfer data between C++ and Python
54  become more efficient.
55 - [Doxygen](https://www.doxygen.nl/) (only exactly version 1.8.6 is supported)
56  and [Graphviz](https://www.graphviz.org/): required for building
57  documentation.
58 - [Modeller](\ref modeller): needed to use the IMP.modeller module.
59 - [CGAL](\ref CGAL): enables faster geometric operations, such as
60  nonbonded lists.
61 - [Google perf tools](\ref perf): needed only for profiling %IMP code.
62 - [ANN](\ref ANN): certain data structures will be faster if it is available.
63 - [GSL](\ref GSL) (1.13 or later): needed to use the IMP.gsl module.
64 - [OpenCV](\ref OpenCV) (2.1 or later): needed to use the IMP.em2d module or the
65  [idock](@ref idock_pcsk9) and [emagefit](@ref emagefit_3sfd) command
66  line tools.
67 - [FFTW](http://www.fftw.org): needed to use the IMP.em2d or IMP.multifit
68  modules or the [multifit](@ref multifit_3sfd) command line tool.
69 - [libTAU](https://integrativemodeling.org/libTAU.html): needed to use the
70  IMP.cnmultifit module or the [cnmultifit](@ref cnmultifit_groel) command
71  line tool.
72 - [Protobuf](https://github.com/google/protobuf): needed to use the
73  IMP.npctransport module.
74 - An [MPI](@ref IMP::mpi) library is needed to use the IMP.mpi module.
75 - The [scipy](https://scipy.org/install/),
76  [scikit-learn](https://scikit-learn.org/stable/install.html),
77  and [matplotlib](https://matplotlib.org/stable/users/installing/index.html)
78  Python libraries are also recommended.
79 - [Chimera](https://www.cgl.ucsf.edu/chimera/download.html) or
80  [ChimeraX](https://www.rbvi.ucsf.edu/chimerax/) are recommended
81  for visualization of results.
82 
83 The following prerequisites are _bundled_, i.e. they are included with %IMP
84 itself and will be built at the same time as %IMP, unless explicitly
85 requested otherwise (see [CMake](@ref cmake_config) for more information):
86 
87 - [RMF](https://integrativemodeling.org/rmf/) (1.3 or later) for handling
88  RMF files, and the IMP.rmf module.
89 - [python-ihm](https://github.com/ihmwg/python-ihm) for handling mmCIF and
90  BinaryCIF files.
91 
92 (Note that if you build a stable release of %IMP from source code, using
93 versions of dependencies that were released _after_ that %IMP release
94 (e.g. a brand new version of Python), you may run into build issues.
95 Either use older versions of the dependencies, or look at the
96 [patches we've applied to the conda package](https://github.com/conda-forge/imp-feedstock/blob/main/recipe/meta.yaml)
97 and apply them to your source code checkout.)
98 
99 ### Getting prerequisites on Linux {#installation_prereqs_linux}
100 All of the prerequisites should be available as pre-built packages for
101 your Linux distribution of choice. For example, on a Fedora system the
102 following should install most of the prerequisites:
103 
104  sudo dnf install boost-devel gperftools-devel CGAL-devel graphviz gsl-devel cmake hdf5-devel swig fftw-devel opencv-devel python3-numpy
105 
106 ### Getting prerequisites on a Mac {#installation_prereqs_mac}
107 
108 Mac users must first install the developer Command Line Tools, which can be
109 done from the command line by running
110 
111  sudo xcode-select --install
112 
113 These can also be obtained by installing Xcode from the App store, then trying
114 to run a command line tool (such as `clang`) which will prompt to install the
115 tools.
116 
117 Then Mac users should use one of the available collections of Unix tools,
118 such as
119 - [Homebrew](https://brew.sh) (_recommended_) Once you installed `homebrew`
120  do
121 
122  brew tap salilab/salilab
123  brew install boost gmp google-perftools cgal graphviz gsl cmake hdf5 swig fftw mpfr opencv libtau eigen
124 
125  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).
126 - [Macports](https://www.macports.org/) 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
127 
128  sudo port install boost cgal cmake fftw gmp gperftools graphviz gsl eigen hdf5 mpfr ninja opencv protobuf-cpp swig swig-python
129  (as in brew, some of these packages may be optional)
130 
131 - [Conda](https://docs.conda.io/en/latest/) Once you installed conda (typically via the Miniconda or Anaconda distributions), do
132 
133  conda create -n IMP_BUILD -c conda-forge python cxx-compiler c-compiler llvm-openmp swig cmake ninja numpy rmf ihm boost-cpp hdf5 libprotobuf protobuf libopencv eigen fftw gsl libcblas cgal-cpp gmp mpfr mpich numpy
134  conda activate IMP_BUILD
135 
136  As in brew and Macports, some of these packages may be optional. In addition, cgal may not be identified by cmake. IMP will still run just fine. Either way, a solution could be setting the CGAL_DIR environment variable to $CONDA_PREFIX/lib/cmake/CGAL/ before running cmake, or adding a -DCGAL_DIR=$CONDA_PREFIX/lib/cmake/CGAL flag to the cmake command line ($CONDA_PREFIX is an environment variable that points to the folder of the active conda environment).
137 
138 
139 - or [Fink](http://www.finkproject.org/) (not supported)
140 
141 ### Getting prerequisites on Windows {#installation_prereqs_windows}
142 
143 We recommend Linux or Mac for developing with %IMP, as obtaining the
144 prerequisites on Windows is much more involved. However, if you really want
145 to build on Windows, see the
146 [building from source code on Windows](@ref install_windows) page for the
147 procedure we use.
148 
149 
150 ## Download {#installation_download}
151 
152 - Download the source code tarball from [our download page](https://integrativemodeling.org/download.html#source), then extract it with something like:
153 
154  tar -xvzf ../imp-<version>.tar.gz
155 
156 - Alternatively you can use [git](https://git-scm.com/) to get the code
157  directly from our [GitHub repository](https://github.com/salilab/imp)
158  with something like:
159 
160  git clone -b main https://github.com/salilab/imp.git
161  (cd imp && git submodule update --init && ./setup_git.py)
162 
163  (the `main` branch tracks the most recent stable
164  release; alternatively you can use `develop` to get the most recent code,
165  but please check out the [nightly builds results page](https://integrativemodeling.org/nightly/results/)
166  to see if the code is currently stable enough for your purposes).
167 
168 ## Compilation {#installation_compilation}
169 
170 Make a separate directory to keep the compiled version of %IMP in (it's tidier
171 to keep this separate from the source code, and if you need to later you can
172 just delete this directory without affecting the source). Set up the build
173 with [CMake](@ref cmake_config), then finally compile it, with something
174 like:
175 
176  mkdir imp_release
177  cd imp_release
178  cmake <path to IMP source>
179  make -j8
180 
181 There are a number of ways in which %IMP can be configured.
182 See [the configuration options page](@ref cmake_config) for more details
183 and for help with CMake problems.
184 
185 ## Testing {#installation_testing}
186 Once the compilation is complete, you can optionally run the test suite.
187 Test are run using `ctest`. A good start is to run `ctest --output-on-failure`.
188 
189 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"`.
190 
191 Benchmarks are simply tests labeled as `benchmark`; examples are tests labeled as `example`.
192 
193 Note that some test failures are to be expected; compare the failures with
194 those at our own [nightly builds page](https://integrativemodeling.org/nightly/results/)
195 if you are concerned.
196 
197 ## Installation {#installation_install}
198 
199 Once everything is compiled (and optionally tested) you can install %IMP
200 by simply running `make install`. If you opted to install in a non-standard
201 location, it is up to you to set up your environment variables so that %IMP
202 can be found (you may need to set `PATH`, `PYTHONPATH`, and `LD_LIBRARY_PATH`).
203 
204 Alternatively, you can run %IMP directly from the build directory by using
205 the `setup_environment.sh` script. This sets the necessary environment
206 variables and then runs the rest of the command line with this modified
207 environment. For example, to run the `ligand_score` command line tool you
208 can either run
209 
210  ./setup_environment.sh ligand_score <arguments>
211 
212 or create a new shell with
213 
214  ./setup_environment.sh $SHELL
215 
216 and then run
217 
218  ligand_score <arguments>
219 
220 in that shell.