"Fossies" - the Fresh Open Source Software Archive

Member "openmpi-3.1.6/INSTALL" (18 Mar 2020, 3469 Bytes) of package /linux/misc/openmpi-3.1.6.tar.bz2:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
    2                         University Research and Technology
    3                         Corporation.  All rights reserved.
    4 Copyright (c) 2004-2005 The University of Tennessee and The University
    5                         of Tennessee Research Foundation.  All rights
    6                         reserved.
    7 Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
    8                         University of Stuttgart.  All rights reserved.
    9 Copyright (c) 2004-2005 The Regents of the University of California.
   10                         All rights reserved.
   11 Copyright (c) 2008-2015 Cisco Systems, Inc.  All rights reserved.
   12 $COPYRIGHT$
   13 
   14 Additional copyrights may follow
   15 
   16 $HEADER$
   17 
   18 
   19 For More Information
   20 ====================
   21 
   22 This file is a *very* short overview of building and installing Open
   23 MPI, and building MPI applications.  Much more information is
   24 available on the Open MPI web site (e.g., see the FAQ section):
   25 
   26     http://www.open-mpi.org/
   27 
   28 
   29 Developer Builds
   30 ================
   31 
   32 If you have checked out a DEVELOPER'S COPY of Open MPI (i.e., you
   33 cloned from Git), you should read the HACKING file before attempting
   34 to build Open MPI.  You must then run:
   35 
   36 shell$ ./autogen.pl
   37 
   38 You will need very recent versions of GNU Autoconf, Automake, and
   39 Libtool.  If autogen.pl fails, read the HACKING file.  If anything
   40 else fails, read the HACKING file.  Finally, we suggest reading the
   41 HACKING file.
   42 
   43 *** NOTE: Developer's copies of Open MPI typically include a large
   44 performance penalty at run-time because of extra debugging overhead.
   45 
   46 
   47 User Builds
   48 ===========
   49 
   50 Building Open MPI is typically a combination of running "configure"
   51 and "make".  Execute the following commands to install the Open MPI
   52 system from within the directory at the top of the tree:
   53 
   54 shell$ ./configure --prefix=/where/to/install
   55 [...lots of output...]
   56 shell$ make all install
   57 
   58 If you need special access to install, then you can execute "make
   59 all" as a user with write permissions in the build tree, and a
   60 separate "make install" as a user with write permissions to the
   61 install tree.
   62 
   63 Compiling support for various networks or other specific hardware may
   64 require additional command ling flags when running configure.  See the
   65 README file for more details.  Note that VPATH builds are fully
   66 supported.  For example:
   67 
   68 shell$ tar xf openmpi-X.Y.Z.tar.gz
   69 shell$ cd openmpi-X.Y.Z
   70 shell$ mkdir build
   71 shell$ cd build
   72 shell$ ../configure ...your options...
   73 [...lots of output...]
   74 shell$ make all install
   75 
   76 Parallel builds are also supported (although some versions of "make",
   77 such as GNU make, will only use the first target listed on the command
   78 line when executable parallel builds).  For example (assume GNU make):
   79 
   80 shell$ make -j 4 all
   81 [...lots of output...]
   82 shell$ make install
   83 
   84 Parallel make is generally only helpful in the build phase (i.e.,
   85 "make all"); the installation process (i.e., "make install") is mostly
   86 serial and does not benefit much from parallelization.
   87 
   88 
   89 Compiling MPI Applications
   90 ==========================
   91 
   92 MPI applications should be compiled using the Open MPI "wrapper"
   93 compilers:
   94 
   95 C programs:       mpicc your-code.c
   96 C++ programs:     mpiCC your-code.cc    or
   97                   mpic++ your-code.cc   (for case-insensitive filesystems)
   98 Fortran programs: mpifort your-code.f90
   99 
  100 These compilers simply add various command line flags (such as -lmpi)
  101 and invoke a back-end compiler; they are not compilers in themselves.