source: trunk/Bonmin/doc/BOUM_Obtain.tex @ 1

Last change on this file since 1 was 1, checked in by andreasw, 13 years ago

imported initial code

File size: 2.5 KB
Line 
1\PageHead{Downloading \Bonmin}
2\StartPageSummary
3\PageSection{Obtaining \Bonmin}{sec:obtain}
4\PageSection{Obtaining required third party code}{sec:obtain_3rd}
5\EndPageSummary
6\NavigationPanel
7
8
9
10\PageTitle{Obtaining \Bonmin}{sec:obtain}
11
12
13You can obtain the \Bonmin\ package by using
14\link{http://subversion.tigris.org/}{subversion}.
15
16The \Bonmin\ package consists of the source code for the \Bonmin\
17project but also source code from other \COINOR\ projects:
18\begin{itemize}
19\item \BuildTools
20\item \Cbc
21\item \Cgl
22\item \Clp
23\item \CoinUtils
24\item \Ipopt
25\item \Osi
26\end{itemize}
27
28When downloading the \Bonmin\ package you will download the source code for all these and
29libraries of problems to test the codes.\\
30
31In Unix\footnote{UNIX is a registered trademark of The Open
32Group.}-like environments, make a directory, say {\tt Bonmin-dist} where you want to
33download the code. Change to {\tt Bonmin-dist}, and issue the following
34command:
35%\begin{verbatim}
36\break
37
38 \noindent {\tt  svn co
39svn+ssh://pbonami-lx.tepper.cmu.edu/home/cvs/svn/BONMIN/trunk~. }
40
41%\end{verbatim}
42\noindent and when asked for a login and password type the ones you
43were provided with (of course this will change with the release).
44This copies all the necessary COIN-OR files to compile \Bonmin\ to
45{\tt Bonmin-dist}. To download \Bonmin\ using svn on Windows,
46follow the instructions provided at
47\link{http://www.coin-or.org/faqs.html\#q4}{COIN-OR}.
48
49\subsectionH{Obtaining required third party code}{sec:obtain_3rd}
50\Bonmin\ needs a few external packages which are not included in the \Bonmin\ package:
51\begin{itemize}
52\item Lapack (Linear Algebra PACKage)
53\item Blas (Basic Linear Algebra Subroutines)
54\item the sparse linear solver MA27 from the Harwell Subroutine Library and optionally (but strongly recommended) MC19 to enable automatic scaling in \Ipopt.
55\item optionally ASL (the Ampl Solver Library), to be able to use \Bonmin\ from Ampl.
56\end{itemize}
57
58Since these third-party software modules are released under licenses
59that are incompatible with the CPL, they cannot be included for
60distribution with \Bonmin\ from COIN-OR, but you will find scripts
61to help you download them in the subdirectory {\tt ThirdParty} of
62the \Bonmin\ distribution\footnote{In most Linux distribution and
63CYGWIN, Lapack and Blas are available as prebuilt binary packages in
64the distribution (and are probably already installed on your
65machine).}. For details on how to obtain these package, refer to the
66instructions in
67\link{http://www.coin-or.org/Ipopt/documentation/node13.html}{Section 2.2} of the Ipopt manual.\\
Note: See TracBrowser for help on using the repository browser.