forked from coin-or/MibS
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME
221 lines (166 loc) · 7.49 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# MibS (Mixed Integer Bilevel Solver) 0.95
[](https://travis-ci.org/tkralphs/MibS)
[  ](https://bintray.com/coin-or/download/MibS/_latestVersion)
MibS is a solver for mixed integer bilevel optimization problems. For an
introduction to bilevel optimization, see [this slide
deck](http://coral.ie.lehigh.edu/~ted/files/talks/BILEVEL-IWOBIP16.pdf). A
somewhat outdated but still useful introduction to MibS is
[here](http://coral.ie.lehigh.edu/~ted/files/talks/BILEVEL-INFORMS11.pdf).
## SUPPORTED PLATFORMS
MiBS should work on all major patforms (OS X, Linux, and Windows), though the
software is in active development and most recent testing has been on Linux.
## DEPENDENCIES
MibS depends on the [CHiPPS](https://projects.coin-or.org/CHiPPS),
[Cbc](https://projects.coin-or.org/Cbc), and [SYMPHONY]
(https://projects.coin-or.org/SYMPHONY) projects of COIN-OR. If you already
have these installed, you can build and link MibS against the installed
version. Otherwise, by following the instruction below, you'll be able to
download, build, and install all dependencies.
## DOWNLOADING
Binary packages are available for some platforms from [Bintray](https://bintray.com/coin-or/download/MibS).
## BUILDING AND INSTALLING
### Building on Linux
Most Linux distributions come with all the required tools installed.
To obtain the source code, open a terminal and do
```
git clone --branch=library https://www.github.com/tkralphs/MibS
```
To build from source, there is a script that fetches dependent projects
and builds automatically. To get the script amd perform the build, do
```
cd MibS
git clone https://github.com/coin-or-tools/BuildTools/
```
and then execute
```
BuildTools/get.dependencies fetch
BuildTools/get.dependencies build --quiet
```
This will build all required dependencies and MibS itself. Afterwards, the
binaries will be installed in the directory `Mibs/build/bin` and the libraries
in the directory `MibS/build/lib`. If you wish to install in a different
directory, such as `/usr/local`, then run the command
```
BuildTools/get.dependencies install --prefix=/path/to/install/dir
```
After installation, you will also need to add `/your/install/dir/bin` to your
`PATH` variable in your `.bashrc` and also add `/your/install/dir/lib`
to your `LD_LIBRARY_PATH` if you want to link to COIN libraries.
### Building on Windows (MSys2/CYGWIN and MinGW/MSVC)
By far, the easiest way to build on Windows is with the GNU autotools and the
MinGW compilers.
1. The first step is to install either [Msys2](https://msys2.github.io/) or
[CYGWIN](http://cygwin.org/). If you don't already
have CYGWIN installed, it is recommended to use MSys2, since it provides a
minimal toolset that is easy to install.
2. To get MSys2, either download the installer
[here](https://msys2.github.io/) or download and unzip MSys2 base from
[here](http://kent.dl.sourceforge.net/project/msys2/Base/x86_64/msys2-base-x86_64-20150512.tar.xz).
3. Either run `msys2_shell.bat` or manually add `msys64\usr\bin`,
`msys64\mingw32\bin`, and `msys64\mingw64\bin` to your Windows path.
4. Open a Windows terminal and type
```
bash
pacman -S make wget tar patch dos2unix diffutils git svn
```
5. Obtain the source code with
```
git clone --branch=library https://www.github.com/tkralphs/MibS
```
6. To build from source, there is a script that fetches dependent projects
and builds automatically. To get the script amd perform the build, do
```
cd MibS
git clone https://github.com/coin-or-tools/BuildTools/
```
and then execute
```
BuildTools/get.dependencies fetch
BuildTools/get.dependencies build --quiet
```
This will build all required dependencies and MibS itself. Afterwards, the
binaries will be installed in the directory `Mibs/build/bin` and the libraries
in the directory `MibS/build/lib`. If you wish to install in a different
directory, such /c/Program\ Files\ \(x86\)/MibS, then run the command
```
BuildTools/get.dependencies install --prefix=/path/to/install/dir
```
7. To use the resulting binaries and/or libraries, you will need to add the
full path of the directory `MibS\build\bin` to your Windows executable
search `PATH`, or, alternatively, copy this directory to `C:\Program Files
(x86)` and add the directory `C:\Program Files (x86)\MibS\bin` to your
Windows executable search `PATH`. You may also consider copying the
`build\lib` and `build\include` directories if you want to link to the
COIN-OR libraries.
It is possible to use almost the exact same commands to build with the Visual
Studio compilers. Before doing any of the above commands in the Windows
terminla, first run the `vcvarsall.bat` script for your version of Visual
Studio. Note that you will also need a compatible Fortran compiler if you want
to build any projects requiring Fortran (`ifort` is recommended, but not
free). Then follow all the steps above, but replace the `build` command
with
```
BuildTools/get.dependencies build --quiet --enable-msvc
```
### Building on OS X
OS X is a Unix-based OS and ships with many of the basic components needed to
build COIN-OR, but it's missing some things. For examples, the latest versions
of OS X come with the `clang` compiler but no Fortran compiler. You may also
be missing the `wget` utility and `subversion` and `git` clients (needed for
obtaining source code). The easiest way to get these missing utilitites is to
install Homebrew (see http://brew.sh). After installation, open a terminal and
do
```
brew install gcc wget svn git
```
```
git clone --branch=library https://www.github.com/tkralphs/MibS
```
To build from source, there is a script that fetches dependent projects
and builds automatically. To get the script amd perform the build, do
```
cd MibS
git clone https://github.com/coin-or-tools/BuildTools/
```
and then execute
```
BuildTools/get.dependencies fetch
BuildTools/get.dependencies build --quiet
```
This will build all required dependencies and MibS itself. Afterwards, the
binaries will be installed in the directory `Mibs/build/bin` and the libraries
in the directory `MibS/build/lib`.
With this setup, `clang` will be used for compiling C++ by default and
`gfortran` will be used for Fortran. Since `clang` uses the GNU standard
library, `gfortran` is compatible.
If you want to use the `gcc` compiler provided by Homebrew, then replace the
`build` command above with
```
BuildTools/get.dependencies build --quiet CC=gcc-5 CXX=g++-5
```
If you wish to install in a different
directory, such as `/usr/local`, then run the command
```
BuildTools/get.dependencies install --prefix=/path/to/install/dir
```
After installation, you will also need to add `/your/install/dir/bin` to your
`PATH` variable in your `.bashrc` and also add `/your/install/dir/lib`
to your `DYLD_LIBRARY_PATH` if you want to link to COIN libraries.
## USING
To solve a bilevel program, you must provide both an MPS file and an auxiliary
information file that specifies which variables and constraints are associated
with the each level. Then call mibs like this:
```
mibs -Alps_instance file.mps -MibS_auxiliaryInfoFile aux_file.txt
```
It is also possible to specify additional settings in a parameter file with,
e.g.,
```
mibs -param mibs.par
```
MibS has many parameters. See the example parameter file `mibs.par` and
the header file `MibParam.h` for explanations.
## HELP
Please post questions and issues to the github project page for MibS.
http://github.com/tkralphs/MibS
Enjoy!