Google's software suite for combinatorial optimization.
- About OR-Tools
- Codemap
- Installation
- Experimental Build with CMake
- Quick Start
- Documentation
- Contributing
- License
Google Optimization Tools (a.k.a., OR-Tools) is an open-source, fast and portable software suite for solving combinatorial optimization problems.
The suite contains:
- A constraint programming solver;
- A linear programming solver;
- Wrappers around commercial and other open source solvers, including mixed integer solvers;
- Bin packing and knapsack algorithms;
- Algorithms for the Traveling Salesman Problem and Vehicle Routing Problem;
- Graph algorithms (shortest paths, min cost flow, max flow, linear sum assignment).
We wrote OR-Tools in C++, but also provide wrappers in Python, C# and Java.
This software suite is composed of the following components:
-
makefiles Subsidiary Make files.
-
CMakeLists.txt Top-level for CMake based build.
-
cmake Subsidiary CMake files.
-
bazel Subsidiary Bazel files.
-
ortools Root directory for source code.
- base Basic utilities.
- algorithms Basic algorithms.
- graph Graph algorithms.
- linear_solver Linear solver wrapper.
- glop Google linear solver.
- lp_data Data structures for linear models.
- constraint_solver Constraint and Routing solver.
- sat SAT solver.
- bop Boolean solver based on SAT.
- util Utilities needed by the constraint solver
- com/google/ortools Java source files.
-
examples Root directory for all examples.
-
tools Delivery Tools (e.g. Windows GNU binaries, scripts, dockers)
This software suite has been tested under:
- Ubuntu 16.04 and up (64-bit);
- Apple macOS Mojave with Xcode 7.x (64-bit);
- Microsoft Windows with Visual Studio 2017 (64-bit).
OR-Tools currently builds with a Makefile, but also provides Bazel and CMake support.
For installation instructions (both source and binary), please visit https://developers.google.com/optimization/introduction/installing.
We also provide experimental CMake support.
Please check the
CMake build instructions.
The best way to learn how to use OR-Tools is to follow the tutorials in our developer guide:
https://developers.google.com/optimization/introduction/get_started
If you want to learn from code examples, take a look at the examples in the examples directory.
The complete documentation for OR-Tools is available at: https://developers.google.com/optimization/
The CONTRIBUTING.md file contains instructions on how to submit the Contributor License Agreement before sending any pull requests (PRs). Of course, if you're new to the project, it's usually best to discuss any proposals and reach consensus before sending your first PR.
The OR-Tools software suite is licensed under the terms of the Apache License 2.0.
See LICENSE-2.0 for more information.