source: branches/devel/INSTALL @ 648

Last change on this file since 648 was 352, checked in by andreasw, 13 years ago

updated INSTALL file; reran autotools to get latest changes in BuildTools?

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