source: html/Install.html @ 1586

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

Two typos in links

File size: 11.6 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
2  "http://www.w3.org/TR/html4/loose.dtd"> 
3<html > 
4<head><title></title> 
5<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 
6<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)"> 
7<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)"> 
8<!-- html --> 
9<meta name="src" content="tmp.tex"> 
10<meta name="date" content="2010-01-23 16:47:00"> 
11<link rel="stylesheet" type="text/css" href="bonmin.css"> 
12</head><body 
13>
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="https://projects.coin-or.org/Bonmin">Wiki</a></li>   <li><a href="http://neos.mcs.anl.gov/neos/solvers/minco:Bonmin/AMPL.html"> NEOS </a> </li>  <li><a href="http://egon.cheme.cmu.edu/ibm/page.htm">IBM-CMU OCR </a></li>  <li><a href="http://domino.research.ibm.com/comm/research_projects.nsf/pages/minlp.index.html">  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"> Installation  </h2>  <a href="#sec:install " > Installing <span 
15class="cmtt-10">BONMIN </span> </a> /
16<a href="#sec:cplex&#x02D9;install " > Configuring <span 
17class="cmtt-10">Cplex </span> </a> / <a href="#sec:vpath " > Compiling <span 
18class="cmtt-10">BONMIN</span>&#x00A0;in a external
19directory  </a> / <a href="#sec:ref&#x02D9;man " > Building documentation  </a> / <a href="#sec:test " > Running test program  </a> /   </div> 
20<!--l. 10--><p class="noindent" > <div id="rightPanel"> <div id="headlines"> <h4>References </h4>    <div id="refer"> <p>  1 <a 
21href="https://projects.coin-or.org/BuildTools" >Generic Coin Installation on Coin BuildTools web page</a>  </p> </div>       <div id="refer"> <p>  2 <a 
22href="https://projects.coin-or.org/BuildTools" >Known issues for
23building Coin packages</a>  </p> </div>       <div id="refer"> <p>  3 <a 
24href="https://projects.coin-or.org/Bonmin/wiki/GettingStarted" ><span 
25class="cmtt-10">BONMIN</span>&#x00A0;build Wiki page.</a>  </p> </div>       <div id="refer"> <p>  4 <a 
26href="https://projects.coin-or.org/Bonmin/Wiki/CygwinInstall" >Specific Instructions for
27building <span 
28class="cmtt-10">BONMIN</span>&#x00A0;on Cygwin</a>  </p> </div>       <div id="refer"> <p>  5 <a 
29href="https://projects.coin-or.org/Bonmin/Wiki/OsXInstall" >Specific instructions for building <span 
30class="cmtt-10">BONMIN</span>&#x00A0;on Mac
31OSX</a>  </p> </div>     </div> </div> 
32 </div> <div id="content"> <div class="feature"> <h3> Installing <span 
33class="cmtt-10">BONMIN </span></h3> The build process for <span 
34class="cmtt-10">BONMIN</span>&#x00A0;should be fairly automatic as it
35uses <a 
36href="http://sources.redhat.com/autobook/autobook/" >GNU autotools</a>. It has been successfully compiled and run on the following
37platforms:
38     <ul class="itemize1">
39     <li class="itemize">Linux using g++ version 3.4 and 4.0
40     </li>
41     <li class="itemize">Windows using version Cygwin 1.5.18
42     </li>
43     <li class="itemize">Mac OS X using gcc 3.4 and 4.0</li></ul>
44<!--l. 27--><p class="noindent" >For Cygwin and OS X some specific setup has to be done prior to instalation.
45These step are described on the wiki pages of <span 
46class="cmtt-10">Bonmin </span><a 
47href="https://projects.coin-or.org/Bonmin/wiki/CygwinInstall" >CygwinInstall</a> and
48<a 
49href="https://projects.coin-or.org/Bonmin/wiki/OsxInstall" >OsxInstall</a>.
50<!--l. 30--><p class="indent" >   <span 
51class="cmtt-10">BONMIN</span>&#x00A0;is compiled and installed using the commands: <div id="verbatim">
52
53   <table 
54class="verbatim"><tr class="verbatim"><td 
55class="verbatim"><div class="verbatim">
56&#x00A0;<br />./configure&#x00A0;-C
57&#x00A0;<br />make
58&#x00A0;<br />make&#x00A0;install
59&#x00A0;<br />
60</div>
61</td></tr></table>
62<!--l. 38--><p class="nopar" > </div> 
63<!--l. 41--><p class="indent" >   This installs the executable <span 
64class="cmtt-10">bonmin </span>in <span 
65class="cmtt-10">Bonmin-1.3/bin</span>. In what follows, we
66assume that you have put the executable <span 
67class="cmtt-10">bonmin </span>on your path.
68<!--l. 44--><p class="indent" >   The <span 
69class="cmtt-10">configure </span>script attempts to find all of the machine specific settings
70(compiler, libraries,...) necessary to compile and run the code. Although <span 
71class="cmtt-10">configure</span>
72should find most of the standard ones, you may have to manually specify a few of the
73settings. The options for the configure script can be found by issuing the
74command
75<!--l. 49--><p class="indent" >   <div id="verbatim">
76
77   <table 
78class="verbatim"><tr class="verbatim"><td 
79class="verbatim"><div class="verbatim">
80&#x00A0;<br />./configure&#x00A0;--help
81&#x00A0;<br />
82</div>
83</td></tr></table>
84<!--l. 54--><p class="nopar" > </div> 
85<!--l. 57--><p class="indent" >   For a more in depth description of these options, the reader is invited to refer to
86the COIN-OR <span 
87class="cmtt-10">BuildTools </span><a 
88href="https://projects.coin-or.org/BuildTools" >trac page</a>.
89<!--l. 60--><p class="indent" >    </div> <div class="story"> <h3><a name=  &#8221;sec:cplex&#x02D9;install&#8221; ></a> Specifying the location of <span 
90class="cmtt-10">Cplex </span>libraries  </h3>   If you have <span 
91class="cmtt-10">Cplex</span>
92installed on your machine, you may want to use it as the Mixed Integer Linear
93Programming subsolver in <span 
94class="cmtt-10">B-OA</span>, <span 
95class="cmtt-10">B-Hyb </span>and <span 
96class="cmtt-10">B-iFP</span>. To do so you have to specify the
97location of the header files and libraries. You can either specify the location of the
98header files directory by passing it as an argument to the configure script or by
99writing it into a <span 
100class="cmtt-10">config.site</span>.
101<br class="newline" />
102<!--l. 68--><p class="indent" >   In the former case, specify the location of the <span 
103class="cmtt-10">Cplex </span>header files by using the
104argument <span 
105class="cmtt-10">--with-cplexincdir </span>and the location of the <span 
106class="cmtt-10">Cplex  </span>library with
107<span 
108class="cmtt-10">--with-cplexlib </span>(note that on the Linux platform you will also need to add
109<span 
110class="cmtt-10">-lpthread </span>as an argument to <span 
111class="cmtt-10">--with-cplexlib</span>).
112<br class="newline" />
113<!--l. 73--><p class="indent" >   For example, on a Linux machine if <span 
114class="cmtt-10">Cplex </span>is installed in <span 
115class="cmtt-10">/usr/ilog</span>&#x00A0;, you would
116invoke configure with the arguments as follows:
117<!--l. 76--><p class="indent" >   <div id="verbatim">
118
119   <table 
120class="verbatim"><tr class="verbatim"><td 
121class="verbatim"><div class="verbatim">
122&#x00A0;<br />./configure&#x00A0;--with-cplex-incdir=/usr/ilog/cplex/include/ilcplex&#x00A0;\
123&#x00A0;<br />&#x00A0;&#x00A0;--with-cplex-lib="/usr/ilog/cplex/lib/libcplex.a&#x00A0;-lpthread"
124&#x00A0;<br />&#x00A0;
125</div>
126</td></tr></table>
127<!--l. 81--><p class="nopar" > </div> 
128<!--l. 84--><p class="indent" >   In the latter case, put a file called <span 
129class="cmtt-10">config.site </span>in a subdirectory named <span 
130class="cmtt-10">share </span>of
131the installation directory (if you do not specify an alternate installation directory to
132the <span 
133class="cmtt-10">configure </span>script with the <span 
134class="cmtt-10">--prefix </span>argument, the installation directory is the
135directory where you execute the <span 
136class="cmtt-10">configure </span>script). To specify the location of
137<span 
138class="cmtt-10">Cplex</span>&#x00A0;, insert the following lines in the <span 
139class="cmtt-10">config.site </span>file:
140<!--l. 91--><p class="indent" >   <div id="verbatim">
141
142   <table 
143class="verbatim"><tr class="verbatim"><td 
144class="verbatim"><div class="verbatim">
145&#x00A0;<br />&#x00A0;with_cplex_lib="/usr/ilog/cplex/lib/libcplex.a&#x00A0;-lpthread"
146&#x00A0;<br />&#x00A0;with_cplex_incdir="/usr/ilog/cplex/include/ilcplex"
147&#x00A0;<br />
148&#x00A0;<br />&#x00A0;
149</div>
150</td></tr></table>
151<!--l. 97--><p class="nopar" > </div> 
152<!--l. 100--><p class="indent" >   (You will find a <span 
153class="cmtt-10">config.site </span>example in the subdirectory <span 
154class="cmtt-10">BuildTools </span>of
155<span 
156class="cmtt-10">coin-Bonmin</span>.)
157<!--l. 102--><p class="indent" >    </div> <div class="story"> <h3><a name=  &#8221;sec:vpath&#8221; ></a> Compiling <span 
158class="cmtt-10">BONMIN</span>&#x00A0;in a external directory  </h3>   It is recommended to
159compile <span 
160class="cmtt-10">BONMIN</span>&#x00A0;in a directory different from the source directory (<span 
161class="cmtt-10">Bonmin-1.3 </span>in our
162case). This is convenient if you want to have several executables compiled for
163different architectures or have several executables compiled with different options
164(debugging and production, shared and static libraries) but also because you don&#8217;t
165modify the directory where the sources are.
166<br class="newline" />
167<!--l. 108--><p class="indent" >   To do this just create a new directory, for example <span 
168class="cmtt-10">Bonmin-build </span>in
169the parent directory of <span 
170class="cmtt-10">coin-Bonmin </span>and run the configure command from
171<span 
172class="cmtt-10">Bonmin-build</span>:
173<!--l. 112--><p class="indent" >   <div id="verbatim">
174
175   <table 
176class="verbatim"><tr class="verbatim"><td 
177class="verbatim"><div class="verbatim">
178&#x00A0;<br />../Bonmin-\stableVersion/configure&#x00A0;-C
179&#x00A0;<br />
180</div>
181</td></tr></table>
182<!--l. 117--><p class="nopar" > </div> 
183<!--l. 120--><p class="indent" >   This will create the makefiles in <span 
184class="cmtt-10">Bonmin-build</span>, and you can then compile with
185the usual <span 
186class="cmtt-10">make </span>and <span 
187class="cmtt-10">make install </span>(in <span 
188class="cmtt-10">Bonmin-build</span>).
189<!--l. 124--><p class="indent" >    </div> <div class="story"> <h3><a name=  &#8221;sec:ref&#x02D9;man&#8221; ></a> Building the documentation  </h3>   The documentation for
190<span 
191class="cmtt-10">BONMIN</span>&#x00A0;consists of a users&#8217; manual (this document) and a reference manual.
192You can build a local copy of the reference manual provided that you have
193Latex and Doxygen installed on your machine. Issue the command <span 
194class="cmtt-10">make</span>
195<span 
196class="cmtt-10">doxydoc </span>in <span 
197class="cmtt-10">coin-Bonmin</span>. It calls Doxygen to build a copy of the reference
198manual. An html version of the reference manual can then be accessed in
199<span 
200class="cmtt-10">doc/html/index.html</span>.
201<!--l. 136--><p class="indent" >    </div> <div class="story"> <h3><a name=  &#8221;sec:test&#8221; ></a> Running the test programs  </h3>   By issuing the command <span 
202class="cmtt-10">make test</span>&#x00A0;,
203you build and run the automatic test program for <span 
204class="cmtt-10">BONMIN</span>.
205   
206</body></html> 
207
208
209
Note: See TracBrowser for help on using the repository browser.