INSTALL

   1 === Requirements ===
   2
   3  -- CMake 2.8.0 or later
   4  -- C compiler
   5  -- Fortran compiler
   6
   7
   8 === Basic Installation ===
   9
  10 These instructions give a very basic overview of how to configure, compile and
  11 install UNRESPACK on most systems.  If you are using unique install locations
  12 and/or libraries that are not automatically detected please consult the 'Advanced'
  13 section.
  14
  15 1. Create a 'build' directory in the package source directory.
  16
  17    mkdir build
  18    cd build
  19
  20 2. Configure the build system
  21
  22    cmake ..
  23
  24 3. Compile
  25
  26    make
  27
  28 4. Install
  29
  30    sudo make install
  31
  32
  33 === Advanced ===
  34
  35 The build system (CMake) provides mechanisms for specifying non-standard
  36 build parameters.
  37
  38
  39 Compilers & installation
  40 ------------------------
  41
  42    -DCMAKE_Fortran_COMPILER=xxx equal to name of Fortran Compiler you wish to use
  43      (ifort, gfortran)
  44
  45    -DCMAKE_INSTALL_PREFIX=xxx specify the binaries installation prefix
  46                             (default UNRESPACK_source_dir/bin)
  47
  48 Force-fields
  49 ------------
  50
  51    -DUNRES_MD_FF=xxx  compiles the MD versions with given force field.
  52      Options are: GAB, E0LL2Y. Default: GAB
  53
  54    -DUNRES_CSA_FF=xxx compiles the CSA versions with given force field
  55      Options are: CASP3, ALPHA, BETA, ALPHABETA, CASP5, 3P, 4P. Default: 4P.
  56
  57 Please read the online documentation on force fields available at
  58  http://unres.eu/unres#SECTION00090000000000000000
  59
  60
  61 MPI
  62 ---
  63
  64 MPI implementation on your system should be automatically detected ("MPI Found"
  65 message after runing cmake). If not you have two options:
  66
  67 1. Try setting the path to you MPI wrapper implementation
  68
  69    -DMPI_Fortran_COMPILER=xxx MPI wrapper
  70
  71 2. If option 1 fails or your MPI implementation does not come with a compiler wrapper
  72    try setting both the MPI include and library paths manually. This will circumvent
  73    autodetection entirely.
  74
  75    -DMPI_Fortran_INCLUDE_PATH=xxx
  76    -DMPI_Fortran_LIBRARY="xxx"
  77
  78
  79