COIN-OR Binary Distribution Project
===================================

CONTENTS
========

This distribution is a collection of libraries and executables built from
source code available in the COIN-OR source code repository. The COIN-OR
repository is a collection of open-source software for solving a variety of
operations research problems. The source code for building the binaries
included in this distribution, along with a more complete description of the
COIN-OR project, is available for download from the CVS repository at
http://www.coin-or.org. Instructions for duplicating the steps used to create
this archive are below in the BUILD PARAMETERS section. All projects in this
distribution are licensed under the Common Public License version 1.0. See the
accompanying file containing the full text of the license for details.

The projects included in this distribution are:

* Coin Utilities (Coin): A collection of utilities utilized by other COIN
projects.

* Cut Generation Library (Cgl): A collection of separation algorithms used for
solving generic mixed-integer programs.

* Open Solver Interface (Osi): An generic interface to a variety of LP solvers.

* COIN LP Solver (Clp): A library for solving for linear programming problems.

* COIN Branch and Cut (Cbc): A library for solving mixed-integer linear
programming problems.

* Stochastic Modeling Interface (Smi): A generic interface for building and
solving stochastic optimization models.

The archive contents are as follows:

bin/
	clp

lib/
	libCoin.dylib
	libCgl.dylib
	libOsi.dylib
	libOsiClp.dylib
	libOsiCbc.dylib
	libClp.dylib
	libCbc.dylib
	libSmi.dylib

include/ mirrors the contents of these directories in the COIN-OR CVS
repository 

	COIN/Coin/include
	COIN/Cgl/include
	COIN/Osi/include
	COIN/OsiClp/include
	COIN/OsiCbc/include
	COIN/Clp/include
	COIN/Cbc/include
	COIN/Smi/include

README.txt (this file)
AUTHORS.txt (author information for each project)
LICENSE.txt (license information)

INSTALLATION
============

To install, copy the contents of bin, lib, and include to a standard location
such as ~/bin, ~/lib, and ~/include or /usr/local/bin, /usr/local/lib, and
/usr/local/include. Make sure the contents of the bin subdirectory are copied
to a location in your PATH. Also, make sure the contents of the lib directory
are copied to somewhere in your DYLD_LIBRARY_PATH.

BUILD PARAMETERS
================


The code was built using g++ 4.0.1 from a source checkout on 2/13/06. The code
was checked out and built automatically using the file Makefile.dist available
here:

http://www.coin-or.org/cgi-bin/cvsweb.cgi/COIN/Makefiles/Makefile.dist

The command invoked was

make -f Makefile.dist checkout build

The following were the settings used in the build:

OPT_LEVEL = -O2
CXX = g++
LIBTYPE = SHARED
DATE = 2006-02-13
COMPRESSEDFILE = coin-macosx-powerpc-gcc4-13Feb06.tgz

TESTING
=======

Unit test were invoked with the command

make -f Makefile.dist test

This consisted of running the following unit tests, invoked from the command
line as indicated. Note that these unit tests require the additional checkout
and uncompressing of files in the COIN/Mps directory. 

COIN/Coin/unitTest
COIN/Osi/unitTest -testOsiSolverInterface
COIN/Clp/clp -unitTest -presolve on -netlib
COIN/Cbc/cbc -unitTest
COIN/Cgl/unitTest
COIN/Smi/Test/unitTest

All unit tests were successfully run and passed.