################################################################################

This distribution contains the source code for libquo, a high-level, easy to use
programming interface tailored specifically for MPI/MPI+X codes that may benefit
from evolving process binding policies during their execution. QUO allows for
arbitrary process binding policies to be enacted and reverted during the
execution of an MPI/MPI+X application as different computational phases are
entered and exited, respectively.

QUO -- LA-CC-13-076

################################################################################

########################################
## Downloads
########################################
# http://losalamos.github.io/libquo/

########################################
## Building
########################################

# Prerequisites
# libquo requires an implementation of the message passing interface (MPI) and
# hwloc (http://www.open-mpi.org/projects/hwloc). hwloc is included within
# libquo, so the only external dependency is an MPI library.

# Configure libquo
./configure CC=[MPICC] [FC=[MPIFC]] [--prefix=INSTALL-PATH]
# For available configure options, ./configure --help

# Build libquo
make
make install

# Where: MPICC is your system's MPI CC wrapper compiler.
#        MPIFC is your system's MPI Fortran wrapper compiler (Optional).

# Example Configure and Build
./configure CC=mpicc FC=mpif90 && make && make install

# NOTE: a Fortran wrapper compiler is needed only if you wish to build with
# Fortran support.

################################################################################
################################################################################
libquo API
################################################################################
################################################################################

# C Interface Users
See src/quo.h for more information.

# Fortran Interface Users
See src/quof.f90 and src/quo.h for more information.

o Some Fortran interfaces differ slightly from their C equivalent.

# Interface Examples
o In tests and demos.

########################################
# Building Against QUO
########################################

# Example 0
mpicc myquoapp.c -I[QUO-PREFIX]/include -L[QUO-PREFIX]/lib -o myquoapp -lquo
export LD_LIBRARY_PATH=[QUO-PREFIX]/lib:$LD_LIBRARY_PATH

# Example 1
mpicc myquoapp.c -o myquoapp -I[QUO-PREFIX]/include \
-L[QUO-PREFIX]/lib -lquo -Wl,-rpath=[QUO-PREFIX]/lib

# Example 2
mpicc myquoapp.c -o myquoapp `pkg-config --cflags --libs libquo`

################################################################################
################################################################################
libquo Environment Variables
################################################################################
################################################################################
QUO_TMPDIR - specifies the base directory where temporary QUO files will be
             written.

################################################################################
################################################################################
Copyright (c) 2013-2015 Los Alamos National Security, LLC
                        All rights reserved.

Copyright 2013. Los Alamos National Security, LLC. This software was produced
under U.S. Government contract DE-AC52-06NA25396 for Los Alamos National
Laboratory (LANL), which is operated by Los Alamos National Security, LLC for
the U.S. Department of Energy. The U.S. Government has rights to use,
reproduce, and distribute this software.  NEITHER THE GOVERNMENT NOR LOS ALAMOS
NATIONAL SECURITY, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY
LIABILITY FOR THE USE OF THIS SOFTWARE.  If software is modified to produce
derivative works, such modified software should be clearly marked, so as not to
confuse it with the version available from LANL.

Additionally, redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met:

· Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

· Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

· Neither the name of Los Alamos National Security, LLC, Los Alamos National
  Laboratory, LANL, the U.S. Government, nor the names of its contributors may
  be used to endorse or promote products derived from this software without
  specific prior written permission.

THIS SOFTWARE IS PROVIDED BY LOS ALAMOS NATIONAL SECURITY, LLC AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL LOS ALAMOS NATIONAL SECURITY, LLC OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
################################################################################
################################################################################