If you are on Linux or OS X, you will first need to install DIP using
coinbrew. In Windows, there are pre-built
binary wheels and no further installation should be needed. After build and install,
make sure to set PKG_CONFIG_PATH to point to the directory where the
.pc files are installed (by default, this is in the lib/pkgconfig directory
in the installation directory). You may also need to set either LD_LIBRARY_PATH (Linux)
or DYLD_LIBRARY_PATH (OS X) to point to the directory where the libraries are
installed. Then simply do
pip install coinor.dippy
After installation, you can try running the examples to see if trhings are working. These should all work out of the box. For a listing of examples and some brief instructions, do
python -m coinor.dippy.examples
To get help for an example, do, e.g.,
python -m coinor.dippy.example.cflp --help
or just run
python -m coinor.dippy.examples.cflp
These instructions are for building and installing DIP from source. For instructions on how to obtain pre-built binaries, please see the README file.
IMPORTANT: In most cases,you do not need to clone this repository first! Please follow the instructions for your platform below.
Most Linux distributions come with all the required tools installed. To obtain the source code, the first step is to get the installer that will then fetch the source for ALPS and all its dependencies. You do not need to clone this repository first, just do the following! Open a terminal and execute
git clone https://www.github.com/coin-or/coinbrew
Next, to check out source code for and build all the necessary projects
(including dependencies), execute the script in the COIN-OR-OptimizationSuite
subdirectory. To execute the script, do
cd coinbrew
chmod u+x coinbrew
./coinbrew
(Note: The chmod command is only needed if the execute permission is not
automatically set by git on cloning). Once you run the script,
you will be prompted interactively to select a project to fetch and build. The
rest should happen automagically. Alternatively, the following command-line
incantation will execute the procedure non-interactively.
./coinbrew fetch --no-prompt Dip@0.95
./coinbrew build --no-prompt Dip --prefix=/path/to/install/dir
Options that would have been passed to the configure script under the old
build system can simply be added to the command-line. For example, to build
with debugging symbols, do
./coinbrew build --no-prompt Dip --enable-debug
To get help with additional options available in running the script, do
./coinbrew --help
The above procedures will build all required dependencies and Dip itself.
Afterwards, the binaries will be installed in the directory
/path/to/install/dir/bin and the libraries in the directory
/path/to/install/dir/lib. After installation, you will also need to add
/path/to/install/dir/bin to your PATH variable in your .bashrc and also
add /path/to/install/dir/lib to your LD_LIBRARY_PATH if you want to link
to COIN libraries.
By far, the easiest way to build on Windows is with the GNU autotools and the GCC compilers. The first step is to install either
If you don't already have CYGWIN installed and don't want to fool around with WSL (which is a great option if you already know your way around Unix), it is recommended to use MSys2, since it provides a minimal toolset that is easy to install. To get MSys2, either download the installer here or download and unzip MSys2 base from here (this is an out-of-date version, there may be a better place to get an archive version).
Following any of the above steps, you should have the bash command
(with Msys2, be sure to run msys2_shell.bat
or manually add msys64\usr\bin, msys64\mingw32\bin, and
msys64\mingw64\bin to your Windows path).
Once you have bash installed and in your PATH, open a Windows terminal and
type
bash
pacman -S make wget tar patch dos2unix diffutils git svn
To obtain the source code, the first step is to get the installer that will then fetch the source for Dip and all its dependencies. You do not need to clone Dip first, just do the following! Open a terminal and execute
git clone https://www.github.com/coin-or/coinbrew
Next, to check out source code for and build all the necessary projects
(including dependencies), execute the script in the COIN-OR-OptimizationSuite
subdirectory. To execute the script, do
cd coinbrew
chmod u+x coinbrew
./coinbrew
(Note: The chmod command is only needed if the execute permission is not
automatically set by git on cloning). Once you run the script,
you will be prompted interactively to select a project to fetch and build. the
rest should happen automagically. Alternatively, the following command-line
incantation will execute the procedure non-interactively.
./coinbrew fetch --no-prompt Dip@0.95
./coinbrew build --no-prompt Dip --prefix=C:\path\to\install\dir --verbosity=1
Options that would have been passed to the configure script under the old
build system can simply be added to the command-line. For example, to build
with debugging symbols, do
./coinbrew build --no-prompt Dip --enable-debug
To get help with additional options available in running the script, do
./coinbrew --help
To use the resulting binaries and/or libraries, you will need to add the
full path of the directory C:\path\to\install\dir\build\bin to your Windows executable
search PATH, or, alternatively, copy the conents of the build directory to
C:\Program Files (x86)\Dip and add the directory
C:\Program Files (x86)\Dip\bin
to your Windows executable search PATH. You may also consider adding
C:\Program Files (x86)\Dip\lib to the LIB path and
C:\Program Files (x86)\Dip\include to the INCLUDE path.
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
terminal, 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
./coinbrew build --no-prompt Dip --enable-msvc
These instructions are for MSVC++ Version 10. Instructions for other versions should be similar. '''The MSVC++ are not regularly tested so please let us know if they are broken.'''
-
Go to
Dip/MSVisualStudio/v10directory and open the solution filelibDip.sln. -
To test the library, You can build one of the examples by navigating to the Examples/Knap/MSVisualStudio/v10 directory, for example.
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
To obtain the source code, the first step is to get the installer that will then fetch the source for Dip and all its dependencies. You do not need to clone Dip first, just do the following! Open a terminal and execute
git clone https://www.github.com/coin-or/coinbrew
Next, to check out source code for and build all the necessary projects
(including dependencies), execute the script in the COIN-OR-OptimizationSuite
subdirectory. To execute the script, do
cd coinbrew
chmod u+x coinbrew
./coinbrew
(Note: The chmod command is only needed if the execute permission is not
automatically set by git on cloning). Once you run the script,
you will be prompted interactively to select a project to fetch and build. the
rest should happen automagically. Alternatively, the following command-line
incantation will execute the procedure non-interactively.
./coinbrew fetch --no-prompt Dip@0.92
./coinbrew build --no-prompt Dip --prefix=/path/to/install/dir --verbosity=1
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
./coinbrew build --no-prompt Dip CC=gcc-5 CXX=g++-5
Options that would have been passed to the configure script under the old
build system can simply be added to the command-line. For example, to build
with debugging symbols, do
./coinbrew build Dip --enable-debug
To get help with additional options available in running the script, do
./coinbrew --help
After installation, you will also need to add /path/to/install/dir/bin to your
PATH variable in your .bashrc and also add /path/to/install/dir/lib
to your DYLD_LIBRARY_PATH if you want to link to COIN libraries.