source: trunk/INSTALL @ 1543

Last change on this file since 1543 was 1008, checked in by jpfasano, 12 years ago

MSDevStudio changed to MSVisualStudio

File size: 5.0 KB
Line 
1Below are the generic COIN-OR installation instruction.
2
3For Bonmin-specific information look at Bonmin/INSTALL
4
5
6These instructions are for UNIX-like systems (including Linux, Cygwin
7and MSys) only.  If Microsoft Developer Studio projects are
8maintained for this package, you can find instructions at
9
10  https://projects.coin-or.org/MSVisualStudio
11
12**********************************************************************
13***                         DOWNLOAD                               ***
14**********************************************************************
15
16You can obtain the source code for the Bonmin package in two ways:
17
181. Obtain the source directly from the COIN-OR subversion repository
19   (recommended).  For this you needs the program 'svn' installed on
20   your machine, and output of "svn --version" must contain
21   "handles 'https' scheme".
22
23   Assuming that you want to download the code into a subdirectory
24   "Bonmin", you type
25
26   svn co https://projects.coin-or.org/svn/Bonmin/trunk Bonmin
27
282. Download the tarball from http://www.coin-or.org/Tarballs/ and
29   extract it, for example, with
30
31   gunzip Bonmin_2006Jun07.tgz
32   tar xvf Bonmin_2006Jun07.tar
33
34   (Here "2006Jun07" is of course replaced by the string in the
35   tarball you downloaded.)
36
37   More detailed download instructions can be found at
38
39   https://projects.coin-or.org/BuildTools/wiki/user-download
40
41**********************************************************************
42***                        CONFIGURATION                           ***
43**********************************************************************
44
45Go into the directory that you just downloaded or extracted (e.g.,
46Coin-Cbc or Cbc_2006Jun07).  Then you type
47
48   ./configure
49
50Note that you might have to specify additional options, in case you
51don't want to use the default choices that configure makes (e.g.,
52compilers).  Please visit
53
54   https://projects.coin-or.org/BuildTools/wiki/user-configure
55
56and the Bonmin Trac page
57
58   https://projects.coin-or.org/Bonmin
59
60for more information.
61
62If everything went fine, you will see at the end of the output
63
64   "Main configuration of Cbc successful"
65
66**********************************************************************
67***                COMPILATION AND INSTALLATION                    ***
68**********************************************************************
69
70In the directory where you ran the configure script:
71
721. Compile the code by typing
73
74   make
75
762. To test if the code works, you can type
77
78   make test
79
803. To install the code, you type
81
82   make install
83
84   After this, you will find the executables, libraries and header
85   files in the "bin", "lib" and "include" subdirectory, respectively.
86
87More information on the compilation and installation can be found at
88
89   https://projects.coin-or.org/BuildTools/wiki/user-compile
90
91**********************************************************************
92***                     USING THE LIBRARIES                        ***
93**********************************************************************
94
95Now you can link your own code with the installed libraries.  You can
96find examples in the
97
98   Bonmin/examples/
99
100subdirectory, see also the information at
101
102   https://projects.coin-or.org/BuildTools/wiki/user-examples
103
104
105
106==== 8< ======================================================
107
108From here on you find the original installation instructions for the
109previous GNU Makefile build system.  Most details have changed, but
110for now we keep it here so that possibly missing items might be found
111here.
112
113Prerequisites for installation:
114- at the moment on (*)nix platforms you must use g++ 2.95.2 or higher.
115- must use gnu make
116- to make the documentation doxygen must be installed
117
118Targets are put in subdirectories, whose name is derived from the
119platform name (as returned by `uname`) and the optimization level
120(e.g., Linux-g).
121
122To build Osi library and unitTest
123  - read and edit the top of Makefile to select
124      - whether shared or static library should be built
125      - optimization level
126      - where the compiled library should be installed
127        If you want to use the Volume Algorithm as a solver then first
128        you must build and install libvol. See Vol/INSTALL in the COIN
129        root directory.
130  - read and edit ../Makefiles/Makefile.locations to uncomment Clp lines
131  - 'make' to build and install the library.
132  - 'make unitTest' to create the unitTest program. It will be placed
133    in the target subdirectory.
134
135  - 'make doc' to create the html documentation of the classes in the
136    library and place them in doc/html.
137
138To run Osi unitTest
139  - unitTest from Osi directory
140
141To build Cbc executable
142  In This directory 'make unitTest'.  This actually creates and executable
143    cbc in this directory which can both do unit test and act as simple
144    driver.
145  Cbc is fairly complex in that it needs:
146    Cbc, Clp, Coin, Osi and Cgl
147
148  It has been slightly tested with Osl instead of Clp.  It worked but
149        more slowly as it was harder to give hints to OSL or switch off
150        output etc.
151
152Samples/sample2.cpp is preferred driver
153
154For more information see README and files in Samples
155
Note: See TracBrowser for help on using the repository browser.