OR-Tools CMake Build Instructions

Dockers: [AlmaLinux, Alpine, Archlinux, Debian, Fedora, OpenSuse, RockyLinux, Ubuntu]x [C++, Python, Java, .Net]:

Introduction

OR-Tools comes with a CMake-based build (CMakeLists.txt) that can be used on a wide range of platforms (the "C" stands for cross-platform). If you don't have CMake installed already, you can download it for free from http://www.cmake.org/.

CMake works by generating native Makefiles or build projects that can be used in the compiler environment of your choice. You can either build OR-Tools with CMake as a standalone project or incorporate it into an existing CMake project.

Requirement

You'll need:

• CMake >= 3.24.
• A C++20 compiler (GCC 10 or above)

Solvers supported

Here the list of supported solvers:

• CBC
• CLP
• CP-SAT
• CPLEX*
• GLOP
• GLPK*
• HiGHS*
• PDLP
• SCIP
• XPRESS

*: these solvers are disabled by default.

Dependencies

OR-Tools depends on several mandatory librariess, either as infrastructure or as optimization solvers. You can either compile them all at configure time using the option -DBUILD_DEPS=ON (OFF by default) or compile some of them using the options below (see CMake Options below).

• zlib (BUILD_ZLIB),

• bzip2 (BUILD_BZip2),

• Google Abseil-cpp (BUILD_absl),

• Google Protobuf (BUILD_Protobuf),

• COIN-OR solvers:

  • COIN-OR CoinUtils (BUILD_CoinUtils),

  • COIN-OR Osi (BUILD_Osi),

  • COIN-OR Clp (BUILD_Clp),

  • COIN-OR Cgl (BUILD_Cgl),

  • COIN-OR Cbc (BUILD_Cbc),

    note: You can disable the support of COIN-OR solvers (i.e. Cbc and Clp solver) by using -DUSE_COINOR=OFF (ON by default).

• HIGHS (BUILD_HIGHS),

  note: You must enable the support of HiGHS solver by using -DUSE_HIGHS=ON (OFF by default).

• SCIP (BUILD_SCIP),

  note: You can disable the support of SCIP solver by using -DUSE_SCIP=OFF (ON by default).

OR-Tools can also optionally (disabled by default i.e. OFF) be compiled with support for the following third-party solvers:

• GLPK (BUILD_GLPK),

  note: You must enable the support of GLPK solver by using -DUSE_GLPK=ON (OFF by default).

• CPLEX (USE_CPLEX),

warning: Since these solvers are either proprietary (and require a specific license) or available under the GPL, we can't test them on public CI and their support may be broken.

Enabling CPLEX Support

To enable CPLEX support, configure with -DUSE_CPLEX=ON and -DCPLEX_ROOT=/absolute/path/to/CPLEX/root/dir, replacing /absolute/path/to/CPLEX/root/dir with the path to your CPLEX installation. CPLEX_ROOT can also be defined as an environment variable rather than an option at configure time.

For ease of migration from legacy make third_party builds, CMake will also read the CPLEX installation path from the UNIX_CPLEX_DIR environment variable, if defined.

CMake Options

There are several options that can be passed to CMake to modify how the code is built.

To set these options and parameters, use -D<Parameter_name>=<value>.

All CMake options are passed at configure time, i.e., by running

cmake -S. -B<your_chosen_build_directory> -DOPTION_ONE=ON -DOPTION_TWO=OFF ...

before running cmake --build <your_chosen_build_directory>

For example, to generate build files including dependencies in a new subdirectory called 'build', run:

cmake -S. -Bbuild -DBUILD_DEPS:BOOL=ON

and then build with:

cmake --build build

Following is a list of available options, for the full list run:

cmake -S. -Bbuild -LH

Integrating OR-Tools in your CMake Project

You should be able to integrate OR-Tools in your C++ CMake project following one of these methods.

For API/ABI compatibility reasons, if you will be using OR-Tools inside a larger C++ project, we recommend using CMake and incorporate OR-Tools as a CMake subproject (i.e. using add_sudirectory() or FetchContent).

Consuming OR-Tools in a CMake Project

If you already have OR-Tools installed in your system, you can use the CMake command find_package() to include OR-Tools in your C++ CMake Project.

note: You may need to set CMAKE_PREFIX_PATH in order for CMake to find your OR-Tools installation.

cmake_minimum_required(VERSION 3.14)
project(myproj VERSION 1.0)

find_package(ortools CONFIG REQUIRED)

add_executable(myapp main.cpp)
target_link_libraries(myapp ortools::ortools)

Include directories, compile definitions and compile options will be added automatically to your target as needed.

Incorporating OR-Tools into a CMake Super Project

Using add_subdirectory

The recommendations below are similar to those for using CMake within the googletest framework

Thus, you can use the CMake command add_subdirectory() to include OR-Tools directly from a subdirectory of your C++ CMake project.

Note: The ortools::ortools target is in this case an ALIAS library target for the ortools library target.

cmake_minimum_required(VERSION 3.18)
project(myproj VERSION 1.0)

add_subdirectory(or-tools)

add_executable(myapp main.cpp)
target_link_libraries(myapp ortools::ortools)

Again, include directories, compile definitions and compile options will be added automatically to your target as needed.

Using FetchContent

If you have CMake >= 3.18 you can use the built-in module FetchContent instead. Note: The ortools::ortools target is in this case an ALIAS library target for the ortools library target.

cmake_minimum_required(VERSION 3.18)
project(myproj VERSION 1.0 LANGUAGES CXX)

include(FetchContent)
FetchContent_Declare(
  or-tools
  GIT_REPOSITORY https://github.com/google/or-tools.git
  GIT_TAG        main
)

# After the following call, the CMake targets defined by OR-Tools
# will be defined and available to the rest of the build
FetchContent_MakeAvailable(or-tools)

add_executable(myapp main.cpp)
target_link_libraries(myapp ortools::ortools)

note: You may need to use the option -DBUILD_DEPS=ON to get all the OR-Tools dependencies as well.