INSTALL.cmake

   1                     Welcome to GROMACS!
   2
   3 *Note*: Detailed, step-by-step installation instructions
   4 are available on the website
   5 http://www.gromacs.org/Downloads/Installation_Instructions.
   6
   7 *Note*: If you want to use automake for building look at INSTALL.
   8         However, automake will be deprecated in releases after 4.5
   9
  10
  11
  12 Cmake  (cross-platform make) is a relatively new build system that
  13 is gaining in popularity. One of the biggest selling points is
  14 compatibility with MS Windows. Starting with the 4.5 release,
  15 it is possible to configure and compile the source code with it.
  16
  17 GETTING CMAKE
  18
  19 Packages for various platforms can be found on the project's download page.
  20 Most of the Linux distributions come with packages available through the
  21 corresponding package manage. Make sure the installed version is 2.6 or later.
  22 Using CMake
  23
  24 Please read carefully the documentation on the CMake website. Developers
  25 may look at some of the online tutorials.
  26
  27 CONFIGURING WITH DEFAULTS SETTINGS
  28
  29 It is advisable that the configuration and the build of the binaries are done
  30 outside of the source tree. On Linux/Mac, the following will configure
  31 the build with the default settings:
  32
  33 $ tar xvfz gromacs-4.5.tar.gz
  34 $ ls
  35 gromacs-4.5
  36 $ mkdir build
  37 $ cd build
  38 $ cmake ../gromacs-4.5
  39 $ make
  40
  41 On multi-core CPU systems (very likely nowadays), the parallel make will do the job much faster:
  42
  43 $ make -j 4
  44 $ make install
  45
  46 Substitute 4 with the number of available cores.
  47
  48 CONFIGURING WITH CUSTOM OPTIONS
  49
  50 Custom options can be set in a few different ways.A list of the more commonly
  51 used ones can be found at http://www.gromacs.org/Developer_Zone/Cmake/Custom_options.
  52
  53  *command line flag
  54
  55 The values of custom options are supplied with the -D flag. Note that the source path should
  56 be the last argument (otherwise remove the space between -D and the option)!
  57
  58 $ cmake -D GMX_DOUBLE=ON ../gromacs-4.5
  59
  60  *interactive CMake session
  61
  62 $ cmake -i ../gromacs-4.5
  63
  64  *curses cmake interface (ccmake)
  65
  66 $ ccmake ../gromacs-4.5
  67
  68  *CMake GUI
  69
  70 $ cmake-gui ../gromacs-4.5
  71
  72 Explanation about the different options will be presented when using any of the
  73 interactive, curses or gui methods.
  74
  75 All configure options are saved in the CMakeCache.txt file in the build directory.
  76 The file can be edited using a text editor, but after that cmake should be run again.
  77
  78 $ vim CMakeCache.txt
  79 $ cmake ../gromacs-4.5