source: trunk/INSTALL @ 1029

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

added Mumps in ThirdParty?

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