source: trunk/INSTALL @ 121

Last change on this file since 121 was 121, checked in by barahon, 13 years ago

test commit

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.3 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 Vol 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-Vol", you type
20
21   svn co https://projects.coin-or.org/svn/Vol/trunk Coin-Vol
22
232. Download the tarball from http://www.coin-or.org/Tarballs/Vol and
24   extract it, for example, with
25
26   gunzip Vol_2006Jun07.tgz
27   tar xvf Vol_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-Vol or Vol_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 Vol Trac page
52
53   https://projects.coin-or.org/Vol
54
55for more information.
56
57If everything went fine, you will see at the end of the output
58
59   "Main configuration of Vol 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   Vol/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- must use gnu make
110- to make the documentation doxygen must be installed
111
112Targets are put in subdirectories, whose name is derived from the
113platform name (as returned by `uname`) and the optimization level
114(e.g., Linux-g).
115
116To build the library archive for the Volume Algorithm:
117  - read (and edit as needed) the top of the Makefile.
118  - 'make' (same as 'make install') to create the libvol.so (or
119    libvol.a) library archive in the target subdirectory and copies
120    the headers into InstallDir/include and the library into
121    InstallDir/lib.
122  - 'make doc' to create the html documentation of the classes in the
123    library and place them in doc/html.
124
125For a detailed description on how to use the Volume Algorithm library,
126read the documentation on the implementation for the uncapacitated
127facility location (ufl) problem in the doc subdirectory. To see the
128actual implementation of ufl check out the 'Examples' module.
129
Note: See TracBrowser for help on using the repository browser.