Index: kernel/doc/usage.xml =================================================================== --- kernel/doc/usage.xml (revision 541) +++ kernel/doc/usage.xml (working copy) @@ -10,58 +10,100 @@ In order to obtain and compile &IMP;, you will need: -A recent version of -SWIG (1.3.33 or later recommended). + +SWIG (1.3.33 or later). -A recent version of -scons (0.97 or later recommended). + +scons (0.97 or later). -A Subversion -(svn) client. +Boost (1.34 or later). At the moment IMP only uses the Boost headers, so installing the boost headers in /usr/local/include/boost suffices. -The Boost C++ libraries, version 1.30 or later. - Python 2.3 or later. +A Subversion +(svn) client to access the repository. + + + + +Mac + Mac users should use one of the available collections of Unix tools, either MacPorts or Fink. These both include SWIG, scons, subversion and Boost. At the moment Fink does not have a binary installer for Mac OS 10.5, so MacPorts is preferred. + +Do not install any C++ headers in /usr/include on your Mac as the compiler assumes any such headers are C headers. Extra headers not owned by MacPorts or Fink should be placed in /usr/local/include. + + + +Windows + Windows users should probably install Cygwin, but we don't have any of those yet, so we don't really know. + + + + + + +Optional dependencies + + If you want to use &IMP; with &MODELLER; (optional), you should use version 9v2 or later. + - + +Getting and building IMP -You can get the current &IMP; code by running the following: - +If you have subversion installed you can get the current &IMP; code by running +the following: svn co https://svn.salilab.org/imp/trunk imp - + -If you already have a copy of &IMP;, you can update it to the current code -by running (in the imp directory): +To build IMP, in the imp directory type: + +scons + + +Finally, to use IMP within Python, type the following in the +imp directory: -svn update +./bin/imppy.sh python + -To compile, run scons in the -imp directory (it is also recommended that you run -scons test to run all of the unit tests). To install, run -scons install. - +Some other useful commands: + - +If you have checked out a copy of IMP, you can update it to the current code by typing + +svn update + + + To install IMP into install_dir, type + +scons install prefix=install_dir + +Note that installation does not currently work on Mac OS. + + If you want to use &IMP; with &MODELLER;, set the scons -modeller variable to the directory where you have -&MODELLER; installed, e.g. scons modeller=~/modinstall. + modeller variable to the directory where you have +&MODELLER; installed, e.g. scons modeller=~/modinstall Type scons -h to get help on this and other command-line options. + + + + + Index: README =================================================================== --- README (revision 0) +++ README (revision 0) @@ -0,0 +1 @@ +You can find the IMP documentation at https://salilab.org/imp/doc/ \ No newline at end of file