doc/user/compile_guide_linux_fedora.dox

   1 /*
   2 Highly Optimized Object-oriented Many-particle Dynamics -- Blue Edition
   3 (HOOMD-blue) Open Source Software License Copyright 2008-2011 Ames Laboratory
   4 Iowa State University and The Regents of the University of Michigan All rights
   5 reserved.
   6
   7 HOOMD-blue may contain modifications ("Contributions") provided, and to which
   8 copyright is held, by various Contributors who have granted The Regents of the
   9 University of Michigan the right to modify and/or distribute such Contributions.
  10
  11 You may redistribute, use, and create derivate works of HOOMD-blue, in source
  12 and binary forms, provided you abide by the following conditions:
  13
  14 * Redistributions of source code must retain the above copyright notice, this
  15 list of conditions, and the following disclaimer both in the code and
  16 prominently in any materials provided with the distribution.
  17
  18 * Redistributions in binary form must reproduce the above copyright notice, this
  19 list of conditions, and the following disclaimer in the documentation and/or
  20 other materials provided with the distribution.
  21
  22 * All publications and presentations based on HOOMD-blue, including any reports
  23 or published results obtained, in whole or in part, with HOOMD-blue, will
  24 acknowledge its use according to the terms posted at the time of submission on:
  25 http://codeblue.umich.edu/hoomd-blue/citations.html
  26
  27 * Any electronic documents citing HOOMD-Blue will link to the HOOMD-Blue website:
  28 http://codeblue.umich.edu/hoomd-blue/
  29
  30 * Apart from the above required attributions, neither the name of the copyright
  31 holder nor the names of HOOMD-blue's contributors may be used to endorse or
  32 promote products derived from this software without specific prior written
  33 permission.
  34
  35 Disclaimer
  36
  37 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS'' AND
  38 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  39 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND/OR ANY
  40 WARRANTIES THAT THIS SOFTWARE IS FREE OF INFRINGEMENT ARE DISCLAIMED.
  41
  42 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  43 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  44 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  45 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  46 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  47 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  48 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  49 */
  50
  51
  52 /*!
  53 \page page_compile_guide_linux_fedora Compiling HOOMD-blue in Fedora linux
  54
  55 \b Note: This documentation was written and tested in <b>Fedora 10</b>. It may not work for other
  56 versions.
  57
  58 This page assumes that you have a standard terminal window open. Commands to run will
  59 be indicated as below:
  60 \code
  61  $ echo hello
  62 hello
  63 \endcode
  64 " $ " indicates a shell prompt. As demonstrated above, if you type "echo hello", then you should
  65 see the same output obtained above on the next line: "hello"
  66
  67 You must be the root user to install software. Become root by executing the following command.
  68 \code
  69  $ su -
  70 \endcode
  71
  72 \section software_req_install_fedora_dev Development environment
  73
  74 Install g++, boost, python headers, zlib headers, git, and cmake.
  75
  76 \code
  77  $ yum install gcc-c++ boost boost-devel python-devel zlib-devel git-all cmake
  78 \endcode
  79
  80 \section software_req_install_fedora_cuda CUDA environment
  81
  82 Download the current version of the NVIDA CUDA toolkit from
  83 http://developer.nvidia.com/object/gpucomputing.html . The following terminal command is an example
  84 that downloads version 3.2 for Fedora 13 x86_64
  85
  86 \code
  87  $ wget http://www.nvidia.com/object/thankyou.html?url=/compute/cuda/3_2_prod/toolkit/cudatoolkit_3.2.16_linux_64_fedora13.run
  88 \endcode
  89
  90 Install the CUDA toolkit by executing
  91 \code
  92  $ bash cudatoolkit*.run
  93 \endcode
  94 and following the onscreen prompts. Accept the default installation directory.
  95
  96 Add CUDA into the executable and library search paths by creating the following files. Create
  97 <tt>/etc/ld.so.conf.d/cuda.conf</tt> and add the following lines
  98 \code
  99 /usr/local/cuda/lib
 100 /usr/local/cuda/lib64
 101 \endcode
 102 Then run
 103 \code
 104  $ ldconfig
 105 \endcode
 106
 107 Create <tt>/etc/profile.d/cuda.sh</tt> and add the following lines
 108 \code
 109 if ! echo ${PATH} | /bin/grep -q /usr/local/cuda/bin ; then
 110         PATH=/usr/local/cuda/bin:${PATH}
 111 fi
 112 \endcode
 113 You will need to logout and back in for the path setting to take effect.
 114
 115 Download the latest drivers for your GPU from http://www.nvidia.com The following terminal command
 116 is an example that downloads version 260.19.21 for linux x86_64. If you do not have an NVIDIA GPU,
 117 proceed to the section \ref software_req_install_centos_build.
 118 \code
 119  $ wget http://us.download.nvidia.com/XFree86/Linux-x86_64/260.19.21/NVIDIA-Linux-x86_64-260.19.21.run
 120 \endcode
 121
 122 To install the driver, you must exit first logout of your X-windows session. At the login screen,
 123 press ctrl-alt-f1 to reach a text console. Login as root and execute the following commands
 124 \code
 125  $ init 3
 126  $ yum install kernel-devel-`uname -r`
 127  $ bash NVIDIA-Linux-*.run
 128 \endcode
 129 and follow the onscreen prompts to install the driver. Reboot the computer to load the new driver
 130 and re-enter the GUI login screen.
 131 \code
 132  $ shutdown now -r
 133 \endcode
 134
 135 \section  software_req_install_fedora_build Compile hoomd
 136
 137 Log out of any root sessions that have been opened to install software above. Software should be
 138 compiled in a standard user account.
 139
 140 See \ref sec_build_linux_generic_compile for instructions on compiling hoomd.
 141
 142 */
 143
 144
 145
 146