wiki:GettingStarted

Version 9 (modified by pbonami, 12 years ago) (diff)

Clarify

Getting started with Bonmin

Tested platforms

Bonmin has been installed and used on the following systems:

  • Linux using g++ version 3.* and 4.*
  • Windows using Cygwin version 1.5.18 (see the Cygwin packages required in CygwinInstall)
  • Mac OS X using gcc 3.* and 4.* (see how to install some required program in OsxInstall?)

Bonmin should be relatively easy to install on most un*x's provided that you have a C++ and a Fortran compiler. We don't know anybody who has yet tried to build it in the Microsoft Development Studio, the contribution of anybody who uses Microsoft Development Studio and has good knoweldge of it will be very appreciated.

Bonmin instalation follows the guidelines of COIN-OR. We provide here only very brief instructions, please refer to the BuildTools wiki for more details.

Download

First you need to know which branch of Bonmin you want to download. There are currently three branches:

  • The Stable branch,
  • The Released branch,
  • The Development version.

These different version are made according to the guidelines of COIN-OR. The interpretation of this guidelines for the Bonmin project is explained in BonminBranches.

Most user should only be interested in the difference between the stable version and released version. The main distinction between them is that a stable version can evolve over time to include bug fixes and that the released version never changes. The released versions present an advantage in particular if you want to make experiments which you want to be able to reproduce the stable version presents the advantage that it needs less work to update after a bug is fixed.

The easiest way to obtained the released version if by downloading a tarball, and the latest release is Bonmin-0.1.0.

The only way to obain one of the stable versions is through subversion.

In Un*x environments, to download the latest stable version of Bonmin (0.1). Issue the following subversion command

 svn co https://projects.coin-or.org/svn/Bonmin/stable/0.1 Bonmin-0.1

This copies all the necessary COIN-OR files to compile Bonmin to Bonmin-0.1.

Obtaining required third party code

Bonmin needs a few external packages which are not included in the Bonmin package:

  1. Lapack (Linear Algebra PACKage)
  2. Blas (Basic Linear Algebra Subroutines)
  3. the sparse linear solver MA27 from the Harwell Subroutine Library and optionally (but strongly recommended) MC19 to enable automatic scaling in \Ipopt.
  4. optionally ASL (the Ampl Solver Library), to be able to use Bonmin from Ampl.

Since these third-party software modules are released under licenses that are incompatible with the CPL (pay attention to their licenses), they cannot be included for distribution with Bonmin, but you will find scripts to help you download them in the subdirectory ThirdParty of the Bonmin distribution (Detailed instruction can be found in Ipopt manual or in ThirdParty

Instaling Bonmin

To install Bonmin issue the following command in the main Bonmin distribution (coin-Bonmin above) directory:

  1. mkdir build
  2. cd build
  3. ../configure -C
  4. make
  5. make test
  6. make install

Step 1 Create a directory used to build the code (note that this step is optional but is strongly recommended).

Step 3 Runs a configuration script which creates the Makefiles for Bonmin.

Step 4 Builds the Bonmin library and executable.

Step 5 Builds the test program and runs it (should finished with message All tests passed succesfully.

Step 6 Installs the Bonmin library libbonmin, the bonmin executable, and the required header file to use the Bonmin library.

The User's Manual and the BuildTools project have additional details on downloading, building, and installing.