doc/user/compile_guide_mac.dox

   1 /*
   2 Highly Optimized Object-oriented Many-particle Dynamics -- Blue Edition
   3 (HOOMD-blue) Open Source Software License Copyright 2009-2014 The Regents of
   4 the University of Michigan All rights reserved.
   5
   6 HOOMD-blue may contain modifications ("Contributions") provided, and to which
   7 copyright is held, by various Contributors who have granted The Regents of the
   8 University of Michigan the right to modify and/or distribute such Contributions.
   9
  10 You may redistribute, use, and create derivate works of HOOMD-blue, in source
  11 and binary forms, provided you abide by the following conditions:
  12
  13 * Redistributions of source code must retain the above copyright notice, this
  14 list of conditions, and the following disclaimer both in the code and
  15 prominently in any materials provided with the distribution.
  16
  17 * Redistributions in binary form must reproduce the above copyright notice, this
  18 list of conditions, and the following disclaimer in the documentation and/or
  19 other materials provided with the distribution.
  20
  21 * All publications and presentations based on HOOMD-blue, including any reports
  22 or published results obtained, in whole or in part, with HOOMD-blue, will
  23 acknowledge its use according to the terms posted at the time of submission on:
  24 http://codeblue.umich.edu/hoomd-blue/citations.html
  25
  26 * Any electronic documents citing HOOMD-Blue will link to the HOOMD-Blue website:
  27 http://codeblue.umich.edu/hoomd-blue/
  28
  29 * Apart from the above required attributions, neither the name of the copyright
  30 holder nor the names of HOOMD-blue's contributors may be used to endorse or
  31 promote products derived from this software without specific prior written
  32 permission.
  33
  34 Disclaimer
  35
  36 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS'' AND
  37 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  38 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND/OR ANY
  39 WARRANTIES THAT THIS SOFTWARE IS FREE OF INFRINGEMENT ARE DISCLAIMED.
  40
  41 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  42 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  43 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  44 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  45 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  46 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  47 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48 */
  49
  50
  51 /*!
  52 \page page_compile_guide_mac Compiling HOOMD-blue on Mac OS X
  53
  54 Table of contents:
  55  - \ref sec_build_mac_prereq
  56  - \ref sec_build_mac_compile
  57 <hr>
  58
  59 \section sec_build_mac_prereq Software Prerequisites
  60
  61 HOOMD-blue requires a number of prerequisite software packages and libraries to be installed before it can be compiled.
  62 Macports (http://www.macports.org) greatly simplifies the installation of these.
  63
  64 This page assumes that you have a standard terminal window open. Commands to run in the terminal will be indicated as
  65 below:
  66 ~~~~.bash
  67 $ echo hello
  68 hello
  69 ~~~~
  70 `$` indicates a shell prompt. As demonstrated above, if you type `echo hello`, then you should see the same output
  71 obtained above on the next line: `hello`
  72
  73 1. **Install macports:**
  74 Go to [the macports homepage](http://www.macports.org) and download the appropriate dmg for your system. Mount the dmg
  75 by double-clicking on it. Double-click on the pkg installer for macports and follow the on-screen instructions to
  76 complete the install. If you have not yet installed the Apple developer tools (Xcode) on your system, you will need to
  77 do so now. Follow the instructions in [the macports documentation](http://guide.macports.org/). Then run the macports
  78 selfupdate command to bring your install fully up to date:
  79 ~~~~.bash
  80 $ sudo port selfupdate
  81 ...
  82 ~~~~
  83
  84 2. **Install cmake, boost, and python:**
  85 Run the following command in a terminal to install all prerequisite software to build hoomd.
  86 ~~~~.bash
  87 $ sudo port install cmake boost +python27 python_select openmpi-default
  88 ~~~~
  89 After macports finishes the above command, run
  90 ~~~~.bash
  91 $ sudo port select python python27
  92 $ sudo port select mpi openmpi-mp-fortran
  93 ~~~~
  94 to select the python that macports installed. This step is crucial, or else you will get python <i>version mismatch</i>
  95 or <i>'NoneType'</i> errors when trying to run hoomd.
  96 You can switch back to the Apple installed python at any time by running
  97 ~~~~
  98 $ sudo port select python python26-apple
  99 ~~~~
 100 or see a list of all python installations you can switch between with
 101 ~~~~
 102 $ port select python
 103 ~~~~
 104
 105 3. **Install the NVIDIA CUDA toolkit and driver:**
 106 If you have an NVIDIA GPU, Download the NVIDIA CUDA Toolkit (version 5.5 or newer) appropriate for your system from
 107 [NVIDIA's CUDA download page](https://developer.nvidia.com/cuda-downloads). To install, open Finder, navigate to the
 108 directory where you downloaded the file and double-click on it. Follow the on screen prompts to complete the
 109 installation. Download the [NVIDIA CUDA Drivers](http://www.nvidia.com/object/mac-driver-archive.html).
 110 To install, open Finder, navigate to the directory where you downloaded the file and double-click on it.
 111 Follow the on screen prompts to complete the installation.
 112
 113 4. **Install doxygen:**
 114 [Download the doxygen dmg](http://www.stack.nl/~dimitri/doxygen/). Mount the dmg by double-clicking on it. Install
 115 by dragging Doxygen to your /Applications directory. Class diagrams are generated automatically when you have graphviz
 116 installed. You can install it with macports.
 117 ~~~~.bash
 118 $ sudo port install graphviz
 119 ~~~~
 120
 121 5. **Install git:**
 122 [Download the git dmg](http://git-scm.com/) and install the software.
 123
 124 \section sec_build_mac_compile Compile hoomd
 125
 126 See \ref sec_build_linux_generic_compile for instructions to compile HOOMD-blue.
 127 */