| 1 |
SYMPHONY 5.5 APPLICATION INSTALLATION |
| 2 |
========================================== |
| 3 |
|
| 4 |
This file contains instructions on building all of the SYMPHONY Applications. |
| 5 |
Specific instructions for each particular application are in the individual |
| 6 |
INSTALL files. These instructions are for SYMPHONY 5.5.0, but should work |
| 7 |
for other versions 5.5.* as well. |
| 8 |
|
| 9 |
****************************************************************************** |
| 10 |
* Building in Unix-like environments (UNIX/LINUX/CYGWIN/MINGW/OSX) * |
| 11 |
****************************************************************************** |
| 12 |
|
| 13 |
To build an application, you must first build the SYMPHONY Application library |
| 14 |
as follows. |
| 15 |
|
| 16 |
1. You can obtain the SYMPHONY source code either via the subversion |
| 17 |
repository or in the form of daily tarballs. |
| 18 |
|
| 19 |
The recommended method is to use subversion because it makes it easier to |
| 20 |
obtain updates. In a Unix-like environment (such as Linux or CYGWIN), |
| 21 |
the following command may be used to obtain SYMPHONY from |
| 22 |
source using SVN in most cases: |
| 23 |
|
| 24 |
svn checkout https://projects.coin-or.org/svn/SYMPHONY/releases/5.5.0 SYMPHONY-5.5.0 |
| 25 |
|
| 26 |
The alternative way is to get a daily snapshot of the source code as a tarball |
| 27 |
from the download page of COIN-OR: |
| 28 |
|
| 29 |
http://www.coin-or.org/download/source/SYMPHONY |
| 30 |
|
| 31 |
2. If the code is obtained as a tarball, unpack the distribution with |
| 32 |
|
| 33 |
tar -xzf SYMPHONY-5.5.0.tgz |
| 34 |
|
| 35 |
3. In order to compile SYMPHONY's applications, you must first compile the |
| 36 |
application specific library. Type |
| 37 |
|
| 38 |
cd |
| 39 |
cd SYMPHONY-5.5.0 |
| 40 |
./configure --with-application |
| 41 |
make |
| 42 |
make install |
| 43 |
|
| 44 |
This will create the Makefile of each application together with SYMPHONY's |
| 45 |
application library called 'libSymAppl' to be used while building the app. Note |
| 46 |
that the sequential version library and the executable of SYMPHONY will also be |
| 47 |
made and installed. |
| 48 |
|
| 49 |
4. You are free to move the application directory to wherever you want one |
| 50 |
everrything has been configured. Go to the application directory, |
| 51 |
(SYMPHONY/Applications/XXX if the package was not moved). You can optionally |
| 52 |
modify the variables in the Makefile if you want to add your own defines, |
| 53 |
source or library files, but if you are just building the application, you |
| 54 |
shouldn't need to make any modifications. Then, type |
| 55 |
|
| 56 |
make |
| 57 |
|
| 58 |
The executable "xxx" should be successfully made here. |
| 59 |
|
| 60 |
4. Test the application using the sample file included with the distribution |
| 61 |
according to the instructions in the individual INSTALL files. To specify the |
| 62 |
file name, use the "-F" command-line option, i.e., type something like |
| 63 |
|
| 64 |
xxx -F sample.xxx |
| 65 |
|
| 66 |
COMPILING FOR DISTRIBUTED NETWORKS |
| 67 |
================================== |
| 68 |
|
| 69 |
PLEASE NOTE THAT THE DISTRIBUTED MEMORY PARALLEL VERSION HAS NOT BEEN TESTED |
| 70 |
IN A VERY LONG TIME. PLEASE LET ME KNOW IF YOU WANT TO USE IT AND I WILL GET |
| 71 |
IT WORKING. |
| 72 |
|
| 73 |
1. If you wish to compile a distributed version of the code, obtain and |
| 74 |
install PVM from http://www.csm.ornl.gov/pvm/. |
| 75 |
|
| 76 |
2. Type, |
| 77 |
|
| 78 |
cd |
| 79 |
cd COIN-SYMPHONY |
| 80 |
./configure --with-application --with-pvm |
| 81 |
make |
| 82 |
make install |
| 83 |
|
| 84 |
This will create the the Makefile of the application together with |
| 85 |
SYMPHONY's parallel version application libraries to be used while |
| 86 |
building the application. Note that the sequential version library and the |
| 87 |
executable of SYMPHON will also be made and installed. |
| 88 |
Be sure that, you have PVM installed either in system path or PVM_ROOT |
| 89 |
set as a bash environment variable. By default, configuration will assume |
| 90 |
the following module dependencies: '--with-cg=yes --with-cp=yes --with-lp=no |
| 91 |
--with-tm=yes' (see the user manual or the file 'share/config.site' for more |
| 92 |
information). If you configure with |
| 93 |
|
| 94 |
./configure --with-application --with-pvm --with-lp=yes |
| 95 |
|
| 96 |
then you will end up with the sequential version. Therefore, if you want |
| 97 |
to override the default set up, you must configure without one or more of |
| 98 |
module dependencies. |
| 99 |
|
| 100 |
3. Now you are free to move the application directory to wherever you want. Go |
| 101 |
to the application directory, (SYMPHONY/Applications/XXX if the package was |
| 102 |
not moved). You can optionally modify the variables in the Makefile if you |
| 103 |
want to add your own defines, source or library files, but if you are just |
| 104 |
building the application, you shouldn't need to make any modifications. Then, |
| 105 |
type |
| 106 |
|
| 107 |
make |
| 108 |
|
| 109 |
The executable "xxx_m$(EXT)", where $(EXT) is an extension to be added |
| 110 |
according to the chosen module dependencies, should be successfully made here. |
| 111 |
|
| 112 |
4. Make sure there are links from your '$PVM_ROOT/bin/$PVM_ARCH/' subdirectory |
| 113 |
to each of the executables in your 'bin/' directory. This is required by PVM. |
| 114 |
|
| 115 |
5. Start the PVM daemon by typing "pvm" on the command line and then typing |
| 116 |
"quit". |
| 117 |
|
| 118 |
6. Test the application using the sample file included with the distribution |
| 119 |
according to the instructions in the individual INSTALL files. To specify the |
| 120 |
file name, use the "-F" command-line option, i.e., type something like |
| 121 |
|
| 122 |
xxx_m$(EXT) -F sample.xxx |
| 123 |
|
| 124 |
******************************************************************************* |
| 125 |
* BUILDING APPLICATIONS in MS Windows * |
| 126 |
******************************************************************************* |
| 127 |
|
| 128 |
Here is a sketch outline of how to compile SYMPHONY applications in Microsoft |
| 129 |
Windows. For information on developing your own applications, please see the |
| 130 |
quick start guide below or the detailed explanation in the user's manual. |
| 131 |
Direct support is provided for compilation under MS Visual Studio 10. |
| 132 |
Compilation for other compilers should also be possible. Note that the Windows |
| 133 |
version has some limitations. Detailed timing information is not currently |
| 134 |
provided. Support is only provided for running in sequential mode at this |
| 135 |
time. |
| 136 |
|
| 137 |
First, download SYMPHONY and unpack the archive if it is required. You now |
| 138 |
have three options. Follow the instructions for building SYMPHONY in the |
| 139 |
SYMPHONY INSTALL file, except use the solution file in go to the |
| 140 |
SYMPHONY/Applications/XXX/v10 directory and build the solution. To test the |
| 141 |
executable, type, e.g., |
| 142 |
|
| 143 |
Debug/xxx.exe -F ..\..\sample.xxx |
| 144 |
|
| 145 |
in a terminal window. |