Elaborate documentation and an installation guide can be found at
http://salilab.org/imp/nightly/doc/html/

Building IMP:
=====================

To build IMP source found in `imp-source` and install it in `path_to_install` do:

      1. `cmake path/to/imp-source -DCMAKE_INSTALL_PREFIX=path_to_install`
      2. `make -j 8`
      3. `make install`

Run `ccmake` to see more variables that can be used to customize your build and
install. Note, if you got IMP from `git` you need to run `setup_git.py` or at least
`git submodule init; git submodule update` in the source directory to get the
submodules.

To run IMP without installing, build imp and then use `setup_environment.sh` to
set the required environment variables. For example, to run `ligand_score`, do
`./setup_environment.sh ligand_score arguments...`, or
`./setup_environment.sh $SHELL` and then `ligand_score arguments...` in the
new shell.

See https://github.com/salilab/imp/wiki/Cmake for more information on building
with cmake.

Copyright and License information
=================================

IMP is Copyright 2007-2013 IMP Inventors. The IMP Inventors are
Andrej Sali, Ben Webb, Daniel Russel, Keren Lasker, Dina Schneidman,
Javier Velazquez-Muriel, Friedrich Foerster, Elina Tjioe, Hao Fan,
Seung Joong Kim, Yannick Spill.

IMP is largely available under the GNU Lesser GPL; see the file COPYING.LGPL
for the full text of this license. Some IMP modules are available under the
GNU GPL (see the file COPYING.GPL). Please refer to the documentation at
http://salilab.org/imp/doc.html for more detail.

Files and folders structure:
============================

The lib directory contains Python modules (both pure Python, in the IMP
subdirectory, and C++ extensions, as _IMP_foo.so in the top-level directory)
and the IMP C++ libraries (as libimp_foo.so in the top-level directory).
Rationale: Windows searches for C++ dynamic libraries in the same directory
as C++ Python extensions.

The include directory contains all public header files under the IMP
subdirectory. Modules are in named subdirectories under that.

The swig directory contains all SWIG interface (.i) files used to build
the Python interface.