source: html/Obtain.html @ 1584

Last change on this file since 1584 was 1584, checked in by pbonami, 10 years ago

Documentation in new cleaner html form

File size: 9.2 KB
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
2  ""> 
3<html > 
5<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 
6<meta name="generator" content="TeX4ht ("> 
7<meta name="originator" content="TeX4ht ("> 
8<!-- html --> 
9<meta name="src" content="tmp.tex"> 
10<meta name="date" content="2010-01-23 16:33:00"> 
11<link rel="stylesheet" type="text/css" href="bonmin.css"> 
14<!--l. 1--><p class="noindent" ><div id="header">   <h1 id="siteName"><TT> <big> BONMIN </big> </tt> Users' Manual</h1>   <div id="globalNav">   <a href="Intro.html">Introduction</a> |   <a href="Obtain.html">Download</a> |  <a href="Install.html">Install</a> |   <a href="use.html">Use</a> |   <a href="options_set.html">Setting Options</a> |   <a href="options_list.html">Options List</a> |   <a href="bib.html">Bibliography</a> |  </div>   </div>  <div id="leftPanel"> <div id="side-bar">  <ul> <li class="main"><a href="/Bonmin/index.html">Bonmin</a></li>  <li><a href="">Wiki</a></li>   <li><a href=""> NEOS </a> </li>  <li><a href="">IBM-CMU OCR </a></li>  <li><a href="">  IBM MINLP </a></li>  <br>  <br>  <li class="main"><a href="/index.html">COIN-OR Home</a></li>  <li><a href="/projects.html">Projects</a></li>  <li><a href="/faqs.html">FAQs</a></li>   <li><a href="/download.html">Download</a></li>  <li><a href="/mail.html">Mailing Lists</a></li>  <li><a href="/how-to-help.html">Get Involved</a></li>  <li><a href="/resources.html">Related Resources</a></li>  <li class="main"><a href="/foundation.html">  <br>  <br>  COIN-OR Foundation  </a></li>   <li><a href="/events.html">Events</a></li>  <li><a href="/members.html">Members</a></li>  </ul>  </div> </div> <!--end navBar div -->  <br>   <h2 id="pageName"> Downloading <span 
15class="cmtt-10">BONMIN </span> </h2> <a href="#sec:obtain " >
16Obtaining <span 
17class="cmtt-10">BONMIN </span> </a> / <a href="#sec:obtain&#x02D9;3rd " > Obtaining required third party code  </a> /   </div> 
18<!--l. 7--><p class="noindent" > <div id="rightPanel"> <div id="headlines"> <h4>References </h4>     <div id="refer"> <p>  1 <a 
19href="" >Bonmin Wiki Pages</a>  </p> </div>       <div id="refer"> <p>  2 <a 
20href="" >subversion web page</a>  </p> </div>       <div id="refer"> <p>  3 <a 
21href="" >Using subversion on
22windows</a>  </p> </div>       <div id="refer"> <p>  4 <a 
23href="" >Linear Algebra PACKage</a>  </p> </div>       <div id="refer"> <p>  5 <a 
24href="" >Basic Linear Algebra Subroutines</a>  </p> </div>       <div id="refer"> <p> 
256 <a 
26href="" >Harwell Subroutine Library</a>  </p> </div>       <div id="refer"> <p>  7 <a 
27href="" >Mumps</a>  </p> </div>       <div id="refer"> <p>  8 <a 
28href="" >Ampl Solver Library</a>  </p> </div>     </div> </div> 
29<!--l. 18--><p class="noindent" > </div> <div id="content"> <div class="feature"> <h3> Obtaining <span 
30class="cmtt-10">BONMIN </span></h3>
31<!--l. 22--><p class="indent" >   The <span 
32class="cmtt-10">BONMIN</span>&#x00A0;package consists of the source code for the <span 
33class="cmtt-10">BONMIN</span>&#x00A0;project but also
34source code from other <a 
35href="" >COIN-OR</a>&#x00A0;projects:
36     <ul class="itemize1">
37     <li class="itemize"><a 
38href="" ><span 
40     </li>
41     <li class="itemize"><a 
42href="" ><span 
44     </li>
45     <li class="itemize"><a 
46href="" ><span 
48     </li>
49     <li class="itemize"><a 
50href="" ><span 
52     </li>
53     <li class="itemize"><a 
54href="" ><span 
56     </li>
57     <li class="itemize"><a 
58href="" ><span 
60     </li>
61     <li class="itemize"><a 
62href="" ><span 
64<!--l. 34--><p class="indent" >   When downloading the <span 
65class="cmtt-10">BONMIN</span>&#x00A0;package you will download the source code for all
66these and libraries of problems to test the codes.
67<br class="newline" />
68<!--l. 37--><p class="indent" >   Before downloading <span 
69class="cmtt-10">BONMIN</span>&#x00A0;you need to know which branch of Bonmin you want
70to download. In particular you need to know if you want to download the latest
71version from:
72     <ul class="itemize1">
73     <li class="itemize">the Stable branch, or from
74     </li>
75     <li class="itemize">the Released branch.</li></ul>
77<!--l. 43--><p class="noindent" >These different version are made according to the guidelines of COIN-OR. The
78interpretation of these guidelines for the Bonmin project is explained on the wiki
79pages of Bonmin.
80<!--l. 45--><p class="indent" >   The main distinction between the Stable and Release branch is that a stable
81version that we propose to download may evolve over time to include bug fixes while
82a released version will never change. The released versions present an advantage in
83particular if you want to make experiments which you want to be able to reproduce
84the stable version presents the advantage that it is less work for you to update in the
85event where we fix a bug.
86<!--l. 47--><p class="indent" >   The easiest way to obtain the released version is by downloading a compressed
87archive from <a 
88href="" >Bonmin archive directory</a>. The latest release is Bonmin-1.3.0.
89<!--l. 49--><p class="indent" >   The only way to obain one of the stable versions is through <a 
90href="" >subversion</a>.
91<!--l. 51--><p class="indent" >   In Unix<a 
92href="#Hfootnote.1" ><span class="footnote-mark"><a 
93href="tmp2.html#fn1x0"><sup class="textsuperscript">1</sup></a></span></a><a 
94 id="x1-2f1"></a>-like
95environments, to download the latest stable version of Bonmin (1.3)
96in a sub-directory, say <span 
97class="cmtt-10">Bonmin-1.3 </span>issue the following command
98<!--l. 57--><p class="indent" >   <div id="verbatim"> <span 
99class="cmtt-10">svn co</span><span 
100class="cmtt-10">&#x00A0;Bonmin-1.3 </span></div> 
101<!--l. 62--><p class="noindent" >This copies all the necessary COIN-OR files to compile <span 
102class="cmtt-10">BONMIN</span>&#x00A0;to <span 
103class="cmtt-10">Bonmin-1.3</span>. To
104download <span 
105class="cmtt-10">BONMIN</span>&#x00A0;using svn on Windows, follow the instructions provided at
107href="" >COIN-OR</a>.
108<!--l. 67--><p class="indent" >    </div> <div class="story"> <h3><a name=  &#8221;sec:obtain&#x02D9;3rd&#8221; ></a> Obtaining required third party code  </h3>   <span 
109class="cmtt-10">BONMIN</span>&#x00A0;needs a few
110external packages which are not included in the <span 
112     <ul class="itemize1">
113     <li class="itemize">Lapack (Linear Algebra PACKage)
114     </li>
115     <li class="itemize">Blas (Basic Linear Algebra Subroutines)
116     </li>
117     <li class="itemize">A sparse linear solver.
118     </li>
119     <li class="itemize">Optionally ASL (the Ampl Solver Library), to be able to use <span 
121     Ampl.</li></ul>
122<!--l. 77--><p class="indent" >   Since these third-party software modules are released under licenses that are
123incompatible with the CPL, they cannot be included for distribution with
125class="cmtt-10">BONMIN</span>&#x00A0;from COIN-OR, but you will find scripts to help you download them in
126the subdirectory <span 
127class="cmtt-10">ThirdParty </span>of the <span 
128class="cmtt-10">BONMIN</span>&#x00A0;distribution. In most Linux
129distributions and CYGWIN, Lapack and Blas are available as prebuilt binary
130packages in the distribution (and are probably already installed on your
133<!--l. 86--><p class="indent" >   Linear solvers are used by Ipopt. The most up-to-date information regarding the
134supported linear solvers and how to install them is found in <a 
135href="" >Section 2.2</a> of the Ipopt
137<br class="newline" />
138<!--l. 88--><p class="indent" >   Several options are available for linear solvers: MA27 from the Harwell Subroutine
139Library (and optionally, but strongly recommended, MC19 to enable automatic
140scaling in <a 
141href="" ><span 
142class="cmtt-10">Ipopt</span></a>), MA57 or Mumps. In our experiment MA27 and MA57
143usually perform significantly better but they are freely available only for
144non-commercial, academic use. Note that linear solvers can also take advantage of
Note: See TracBrowser for help on using the repository browser.