source: trunk/INSTALL @ 17

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

cosmetic changes to INSTALL and README

File size: 4.9 KB
Line 
1###############################################################
2#                                                             #
3#                        Couenne                              #
4#                                                             #
5#  (Convex Over and Under ENvelopes for Nonlinear Estimation) #
6#                                                             #
7###############################################################
8
9
10### Downloading Couenne ######################################
11
12Couenne is found in the COIN-OR repository. It can be downloaded with
13Subversion (http://subversion.tigris.org). Run the following command
14(if you are reading this file, you probably have Couenne already and don't
15need to):
16
17$ svn co https://projects.coin-or.org/svn/Couenne/trunk Couenne
18
19
20### Obtaining Third Party code ###############################
21
22Couenne also requires that some third party packages, i.e. software
23that is not found on the COIN-OR repository, be downloaded and
24installed by the user (unless they are already on his/her
25machine). These are ASL, Blas, Lapack, and HSL. For the first three,
26simply move to the corresponding directory and run the get.XXXX script
27file. For instance, ASL can be downloaded as follows:
28
29$ cd ThirdParty/ASL
30$ ./get.ASL
31$ cd ../..
32
33and similarly for Blas and Lapack. To download HSL, see the
34instructions in ThirdParty/HSL/INSTALL.HSL to obtain two files that
35are necessary to Ipopt.
36
37
38### Building Couenne #########################################
39
40To build Couenne, you may just run the commands "configure" and "make".
41However, it is usually desirable to have several builds in separate
42sub-directories.  To do so, create a subdirectory and run configure
43and make from there:
44
45$ mkdir build1
46$ cd build1
47$ ../configure -C
48$ make
49
50The libraries and executables will by default be installed in
51subdirectories of the directory where you have run the configure/make
52scripts. However, by properly setting the configure option --prefix,
53you can install Couenne in a different directory:
54
55$ ../configure --prefix=/usr/local
56
57This installs executables in /usr/local/bin and libraries in
58/usr/local/lib.  You may have to run the "make install" command
59as a super user.
60
61
62
63### Testing. ###################################################
64
65There are a few built-in tests to check whether Couenne is installed
66properly and that it solves certain MINLPs correctly.  Before running
67"make install", you may run
68
69$ make unitTest
70
71to test most features of Couenne (reliability branching, bound
72tightening, etc).  The test may take a few minutes as several MINLP
73problems are solved in the process, each resulting in a short output
74line:
75
76$ make unitTest
77
78Testing couenne.opt.vt
79Global Optimum Test on circle.nl                                OK
80Global Optimum Test on cube.nl                                  OK
81
82...
83
84Global Optimum Test on qquad.nl                                 OK
85Global Optimum Test on sin.nl                                   OK
86Global Optimum Test on small2.nl                                OK
87Global Optimum Test on toy.nl                                   OK
88
89$
90
91If all these tests return OK, congratulations! You have set up Couenne
92correctly.  It is now safe to install Couenne.
93
94
95### Installing and using Couenne. ##############################
96
97Simply run
98
99$ make install
100
101to install header files, libraries, and executables as specified by
102the --prefix option given at the configure command. For instance, if
103option "--prefix=/usr/local/" was given, now the couenne executable is
104found in /usr/local/bin/couenne and you may invoke it simply by
105
106$ couenne stub.nl
107
108(assuming /usr/local/bin is included in your $PATH environent
109variable). If no such option was used, the executable of Couenne is
110found in the bin/ directory. In this case, simply run
111
112$ bin/couenne stub.nl
113
114Where stub.nl is a nonlinear programming problem file created with
115AMPL. Stub files can be generated from AMPL as follows: consider a
116model file xyz.mod and a data file xyz.dat. Run the following AMPL
117commands:
118
119$ ampl
120ampl: model xyz.mod
121ampl: data xyz.dat
122ampl: write gxyz;
123ampl: quit;
124
125This will create a stub file xyz.nl that can be fed to Couenne (notice
126the "g" after the "write" keyword).
127
128Couenne can be fine-tuned by setting parameters in the option file couenne.opt,
129which is read from the same directory where Couenne is launched. A typical
130couenne.opt is provided in Couenne/src/, with some explanation on how to use
131its parameters. You may copy it to your directory and change some of the parameters,
132however those set by default are usually best on most of the instances we have tried.
133
134
135### Documentation ##############################################
136
137Doxygen documentation can be generated by running
138
139$ make doxydoc
140
141from the same build/ directory where you ran configure, make, and make
142install. Documentation in both html and LaTeX format can be found in
143the Doc/ subdirectory. Fire up your browser and take a look at
144Doc/html/index.html for documentation of Couenne.
Note: See TracBrowser for help on using the repository browser.