source: trunk/INSTALL @ 14

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

added couenne.opt, will fill it soon

File size: 4.7 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 following two commands:
41
42$ ./configure
43$ make
44
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 build1
50$ cd build1
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 last command as a super user.
63
64
65
66### Testing. ###################################################
67
68There are a few built-in tests to check that Couenne is installed
69properly and that it solves certain MINLPs correctly.  Before running
70"make install", you may run
71
72$ make unitTest
73
74to test most features of Couenne (reliability branching, bound
75tightening, etc).  The test may take a few minutes as several MINLP
76problems are solved in the process, each resulting in a short output
77line:
78
79$ make unitTest
80
81  Testing couenne.opt.vt
82    Test for couenne.opt.vt       on inst1                OK
83    Test for couenne.opt.vt       on inst2                OK
84    ...
85    Test for couenne.opt.strong_int_br on inst5                OK
86    Test for couenne.opt.strong_int_br on inst6                OK
87    Test for couenne.opt.strong_int_br on inst7                OK
88
89Test succeeded.
90$
91
92If all these tests return OK, congratulations! You have set up Couenne
93correctly.  It is now safe to install Couenne.
94
95
96### Installing and using Couenne. ##############################
97
98Simply run
99
100$ make install
101
102to install header files, libraries, and executables as specified by
103the --prefix option given at the configure command. For instance, if
104option "--prefix=/usr/local/" was given, now the couenne executable is
105found in /usr/local/bin/couenne and you may invoke it simply by
106
107$ couenne stub.nl
108
109(assuming /usr/local/bin is included in your $PATH environent
110variable). If no such option was used, the executable of Couenne is
111found in the bin/ directory. In this case, simply run
112
113$ bin/couenne stub.nl
114
115Where stub.nl is a nonlinear programming problem file created with
116AMPL. Stub files can be generated from AMPL as follows: consider a
117model file xyz.mod and a data file xyz.dat. Run the following AMPL
118commands:
119
120$ ampl
121ampl: model xyz.mod
122ampl: data xyz.dat
123ampl: write gxyz;
124ampl: quit;
125
126This will create a stub file xyz.nl that can be fed to Couenne (notice
127the "g" after the "write" keyword).
128
129Couenne can be fine tuned by setting parameters in the option file couenne.opt,
130which is read from the same directory where Couenne is launched. A typical
131couenne.opt is provided in Couenne/src/, with some explanation on how to use
132its parameters.
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.