In a Nutshell
Projects using OGDF
Team & Contact
The following instructions assume that you are familiar with your operating system and development platform (IDE, compiler).
Recall that OGDF is a pure library, i.e., using OGDF is a two-step process: first, you have to build the library. Then you can use the library (by linking against it) within your own program.
For installing OGDF on Windows with Visual Studio, proceed as follows (for different versions see Configuration Options below):
makeVCXProj.pyto generate Visual Studio 2010 project files
coin.vcxproj, as well as a solution file
ogdf.slnwith Visual Studio and build the projects.
makeVCProj.pyto generate Visual Studio 2008 project files
You can adjust some configuration options by editing
makeVCXProj.config (Visual Studio 2010 and later) or
makeVCProj.config (Visual Studio 2008 and earlier) before executing the python script. This allows you to create projects for different versions of Visual Studio or building OGDF as a DLL. These options are explained in the
.config files; here we discuss some interesting usage scenarios.
[GENERAL] #********************************************************** #* Selects the Visual C++ compiler version #* #* v120 Visual C++ 2013 #* v110 Visual C++ 2012 #* v100 Visual C++ 2010 #* v90 Visual C++ 2008 #* Windows7.1SDK Visual C++ 2010 (Windows 7.1 SDK) platformToolset = v110
DLLoption to true (the option applies only to OGDF, since COIN is always build as static library, and if OGDF is build as DLL the COIN library is linked to the OGDF DLL):
#* Create a static library (false) or DLL (true)? DLL = true
[OGDF] #* Enable OpenMP Support for OGDF? #* (Set to false for Visual Studio Express Editions!) OpenMP = false ... [COIN] #* Enable OpenMP Support for COIN? #* (Set to false for Visual Studio Express Editions!) OpenMP = false
ogdf.slnis created; this can also be disabled by setting
GENERAL) section to
false. This is useful if you have already set up your solution and you just want to reconfigure OGDF.
defaultSolveroption in the
COINsection (default is COIN's
CLP, but you can also choose an external solver such as CPLEX or Gurobi). If you specify an external solver as default solver, it is not necessary to also specify it as external solver.
externalSolvers; in this case, you also have to specify the include directory under
solverIncludes. If you build OGDF as a DLL, you also have to specify the libraries that have to be linked (e.g.,
solverLibs_x64_release). The following example sets CPLEX as default solver:
#* Default solver (one of CLP, SYM, CPX, GRB) defaultSolver = CPX #* External solvers (separated by semicolon) externalSolvers = CPX #* Additional include directories (separated by semicolon) solverIncludes = C:\Program Files\IBM\ILOG\CPLEX_Studio124\cplex\include\ilcplex
For the following explanation, we assume that you installed OGDF in the directory OGDF_INSTALL_DIR. If you want to use the ogdf library in your own projects, proceed as follows.
includedirectory of the OGDF installation which contains the directories
ogdf, so add OGDF_INSTALL_DIR
OGDF_DEBUG(project properties → C++ → Preprocessor → Preprocessor definitions).
coin.libto the library path (project properties → Linker → Additional library directories).
$(SolutionDir)$(Platform)\$(Configuration)\; otherwise use OGDF_INSTALL_DIR
ogdf.lib;coin.lib;as additional libraries for the linker (project properties → Linker → Input → Additional dependencies).
It is also possible to create the documentation directly from the source files if you have Doxygen installed. To build the OGDF HTML documentation, call
doc subdirectory of the OGDF installation (or simply double-click on the file). The documentation will then be written to