generate_readme

#!/usr/bin/env bash

# Exit when command fails
set -e
#Attempt to use undefined variable outputs error message, and forces an exit
set -u
#Causes a pipeline to return the exit status of the last command in the pipe
#that returned a non-zero return value.
set -o pipefail
#set -x

source $COINBREW_HOME/scripts/generate_readme

pushd . > /dev/null
cd $(dirname $0)
SCRIPT_DIR=$PWD
popd > /dev/null

create_variables $SCRIPT_DIR/config.yml

make_header

echo "Welcome to BiCePS, (Branch, Constrain, and Price Software), a
data-handling layer of the CHiPPS (COIN-OR HIgh Performance Parallel Search) 
framework. CHiPPS is a framework for implementing parallel graph search 
algorithms. Its methodology generalizes many of the notions of an LP-based 
branch-and-bound algorithm, allowing the implementation of a wide range of 
algorithms with a simplified interface. BiCePS implements the data-handling 
methods required for implementing relaxation-based branch-and-bound. It is an 
intermediate layer of the CHiPPS library hierarchy that that includes a 
library for solving mixed integer linear programs (BLIS)."

make_build_info_no_packages

echo "## BUILDING with MPI (PARALLEL VERSION)

For configuration and compilation of the parallel version, the user has
to specify the location of MPI with options \`--with-mpi-cflags\`,
\`--with-mpi-lflags\`, \`MPICC\`, and \`MPICXX\`. 

\`\`\`
./coinbrew build Bcps --enable-static --disable-shared \
--with-mpi-cflags=\"\$\(pkg-config --cflags mpi\)\" \
--with-mpi-lflags=\"\$\(pkg-config --libs mpi\)\" MPICC=mpicc MPICXX=mpiCC
\`\`\`

## BUILDING EXAMPLES

To build the example codes (which is an old version of Blis, just used for 
testing), configure and build as above. Switch into the appropriate
subdirectory in the source distribution and type \`make\`."

make_doxygen_info

make_links

echo "## CURRENT TESTING STATUS

  1. Configurations
    - Serial: Well tested.
    - LAMMPI: Well tested.
    - MPICH: Well tested.

  2. Applications (See INSTALL)
    - Blis: an older version of the Blis solver: Well tested.

## Authors

Source Code:

Yan Xu (yax2@lehigh.edu) <br>
Aykut Bulut (aykutblt@gmail.com)  <br>
Ted Ralphs (ted@lehigh.edu), Project Manager

Original Conceptual Design:

Yan Xu (yax2@lehigh.edu) <br>
Ted Ralphs (ted@lehigh.edu), Project Manager <br>
Laci Ladanyi (ladanyi@us.ibm.com) <br>
Matt Saltzman (mjs@clemson.edu)"