source: trunk/INSTALL @ 5

Last change on this file since 5 was 5, checked in by pbelotti, 11 years ago

added projDesc.xml, created trunk/ directory

File size: 4.6 KB
Line 
1Installing Couenne
2
3There are three steps to installing Couenne:
4 - uncompressing couenne.tgz;
5 - obtaining the externals and third party packages;
6 - compiling [and testing].
7
8Couenne currently works on Linux machines.
9
10
11
121. Unzipping Couenne. #########################################
13
14Place the couenne.tgz in a directory of your choice. Then run
15
16$ tar xzf couenne.tgz
17
18There should be a directory named Couenne/ now.
19
20
21
222. Obtaining all externals. ###################################
23
24If you already have all COIN-OR packages necessary to build Couenne,
25i.e., Cbc, Clp, Ipopt, Bonmin, Cgl, and all Third Party packages
26Lapack, Blas, ASL, and HSL, you may move to section 3. The configuring
27script should be able to find those packages.
28
29Couenne uses other COIN-OR packages: Cbc, Clp, Ipopt, Bonmin, Cgl,
30CoinUtils, and BuildTools. These are not included in the .tgz,
31therefore you need to download them using Subversion. Simply run the
32script file getExternals.sh located in the Couenne/ directory:
33
34$ cd Couenne
35$ ./getExternals.sh
36
37THIRD PARTY PACKAGES: Couenne also requires that third party packages
38be downloaded and installed by the user (unless they are already on
39his/her machine) that cannot be found on the COIN-OR repository. These
40are ASL, Blas, Lapack, and HSL. For the first three, simply move to
41the corresponding directory and run the get.XXXX script file. For
42instance, ASL can be downloaded as follows:
43
44$ cd ThirdParty/ASL
45$ ./get.ASL
46$ cd ../..
47
48and similarly for Blas and Lapack. To download HSL, see the
49instructions in ThirdParty/HSL/INSTALL.HSL to obtain two files that
50are necessary to Ipopt.
51
52
53
543. Compiling. #################################################
55
56To build Couenne, you may just run the following two commands:
57
58$ ./configure
59$ make
60
61However, it is usually desirable to have several builds in separate
62sub-directories.  To do so, create a subdirectory and run
63configure and make from there:
64
65$ mkdir build1
66$ cd build1
67$ ../configure
68$ make
69
70The libraries and executables are by default installed in the
71directory where you run the configure/make scripts. However, by
72properly setting the configure option --prefix, you can install
73Couenne in a different directory:
74
75$ ../configure --prefix=/usr/local
76
77This installs executables in /usr/local/bin and libraries in
78/usr/local/lib.  You may have to run the last command as a super user.
79
80
81
824. Testing. ###################################################
83
84There are a few built-in tests to check that Couenne is installed
85properly and that it solves certain MINLPs correctly.  Before running
86make install, you may run
87
88$ make unitTest
89
90to test most features of Couenne (reliability branching, bound
91tightening, etc).  The test may take a few minutes as several MINLP
92problems are solved in the process, each resulting in a short output
93line:
94
95$ make unitTest
96
97  Testing couenne.opt.vt
98    Test for couenne.opt.vt       on alkyl                OK
99    Test for couenne.opt.vt       on batchdes             OK
100    ...
101    Test for couenne.opt.strong_int_br on nvs01                OK
102    Test for couenne.opt.strong_int_br on pb0                  OK
103    Test for couenne.opt.strong_int_br on st_e01               OK
104
105Test succeeded.
106$
107
108If all these tests return OK, congratulations! You have set up Couenne
109correctly.  It is safe now to install Couenne.
110
111
112
1135. Installing and using Couenne. ##############################
114
115Simply run
116
117$ make install
118
119to install header files, libraries, and executables as specified by
120the --prefix option given at the configure command. For instance, if
121option "--prefix=/usr/local/" was given, now the couenne executable is
122found in /usr/local/bin/couenne and you may invoke it simply by
123
124$ couenne stub.nl
125
126(assuming /usr/local/bin is included in your $PATH environent
127variable). If no such option was used, the executable of Couenne is
128found in the bin/ directory. In this case, simply run
129
130$ bin/couenne stub.nl
131
132Where stub.nl is a nonlinear programming problem file created with
133AMPL. Stub files can be generated from AMPL as follows: consider a
134model file xyz.mod and a data file xyz.dat. Run the following AMPL
135commands:
136
137$ ampl
138ampl: model xyz.mod
139ampl: data xyz.dat
140ampl: write gxyz;
141ampl: quit;
142
143This will create a stub file xyz.nl that can be fed to Couenne (notice
144the "g" after the "write" keyword).
145
146
147
1486. Documentation ##############################################
149
150Doxygen documentation can be generated by running
151
152$ make doxydoc
153
154from the same build/ directory where you ran configure, make, and make
155install. Documentation in both html and LaTeX format can be found in
156the Doc/ subdirectory. Fire up your browser and take a look at
157Doc/html/index.html for documentation of Couenne.
Note: See TracBrowser for help on using the repository browser.