Changeset 8 for trunk/INSTALL


Ignore:
Timestamp:
Nov 3, 2008 12:25:48 AM (11 years ago)
Author:
pbelotti
Message:

updated README and INSTALL

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/INSTALL

    r5 r8  
    1 Installing Couenne
    2 
    3 There are three steps to installing Couenne:
    4  - uncompressing couenne.tgz;
    5  - obtaining the externals and third party packages;
    6  - compiling [and testing].
    7 
    8 Couenne currently works on Linux machines.
     1###############################################################
     2#                                                             #
     3#                        Couenne                              #
     4#                                                             #
     5#  (Convex Over and Under ENvelopes for Nonlinear Estimation) #
     6#                                                             #
     7###############################################################
    98
    109
     10### Downloading Couenne ######################################
    1111
    12 1. Unzipping Couenne. #########################################
     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):
    1316
    14 Place the couenne.tgz in a directory of your choice. Then run
    15 
    16 $ tar xzf couenne.tgz
    17 
    18 There should be a directory named Couenne/ now.
     17$ svn co https://projects.coin-or.org/svn/Couenne/trunk Couenne
    1918
    2019
     20### Obtaining Third Party code ###############################
    2121
    22 2. Obtaining all externals. ###################################
    23 
    24 If you already have all COIN-OR packages necessary to build Couenne,
    25 i.e., Cbc, Clp, Ipopt, Bonmin, Cgl, and all Third Party packages
    26 Lapack, Blas, ASL, and HSL, you may move to section 3. The configuring
    27 script should be able to find those packages.
    28 
    29 Couenne uses other COIN-OR packages: Cbc, Clp, Ipopt, Bonmin, Cgl,
    30 CoinUtils, and BuildTools. These are not included in the .tgz,
    31 therefore you need to download them using Subversion. Simply run the
    32 script file getExternals.sh located in the Couenne/ directory:
    33 
    34 $ cd Couenne
    35 $ ./getExternals.sh
    36 
    37 THIRD PARTY PACKAGES: Couenne also requires that third party packages
    38 be downloaded and installed by the user (unless they are already on
    39 his/her machine) that cannot be found on the COIN-OR repository. These
    40 are ASL, Blas, Lapack, and HSL. For the first three, simply move to
    41 the corresponding directory and run the get.XXXX script file. For
    42 instance, ASL can be downloaded as follows:
     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:
    4328
    4429$ cd ThirdParty/ASL
     
    5136
    5237
    53 
    54 3. Compiling. #################################################
     38### Building Couenne #########################################
    5539
    5640To build Couenne, you may just run the following two commands:
     
    6044
    6145However, it is usually desirable to have several builds in separate
    62 sub-directories.  To do so, create a subdirectory and run
    63 configure and make from there:
     46sub-directories.  To do so, create a subdirectory and run configure
     47and make from there:
    6448
    6549$ mkdir build1
    6650$ cd build1
    67 $ ../configure
     51$ ../configure -C
    6852$ make
    6953
    70 The libraries and executables are by default installed in the
    71 directory where you run the configure/make scripts. However, by
    72 properly setting the configure option --prefix, you can install
    73 Couenne in a different directory:
     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:
    7458
    7559$ ../configure --prefix=/usr/local
     
    8064
    8165
    82 4. Testing. ###################################################
     66### Testing. ###################################################
    8367
    8468There are a few built-in tests to check that Couenne is installed
    8569properly and that it solves certain MINLPs correctly.  Before running
    86 make install, you may run
     70"make install", you may run
    8771
    8872$ make unitTest
     
    9680
    9781  Testing couenne.opt.vt
    98     Test for couenne.opt.vt       on alkyl                OK
    99     Test for couenne.opt.vt       on batchdes             OK
     82    Test for couenne.opt.vt       on inst1                OK
     83    Test for couenne.opt.vt       on inst2                OK
    10084    ...
    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
     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
    10488
    10589Test succeeded.
     
    11094
    11195
    112 
    113 5. Installing and using Couenne. ##############################
     96### Installing and using Couenne. ##############################
    11497
    11598Simply run
     
    146129
    147130
    148 6. Documentation ##############################################
     131### Documentation ##############################################
    149132
    150133Doxygen documentation can be generated by running
Note: See TracChangeset for help on using the changeset viewer.