This guide gets you started with OR-Tools in Python with a simple working example.
Although these instructions might also work on other Windows variants, we have only tested them on machines meeting the following requirements:
Windows 10 64-bit (x86_64) with:
- Microsoft Visual Studio [Community] 2022 or
- Microsoft Visual Studio [Community] 2019
The following sections describe the prerequisites for installing OR-Tools.
Microsoft Visual C++ Redistributable
You must have the Microsoft Visual C++ Redistributable for Visual Studio 2019 (select the x64 version) installed on your computer, since OR-Tools library for Python is a wrapper for the C++ native library.
You must have one of the following versions of Python installed:
- Python 3.10.x 64-bit
- Python 3.9.x 64-bit
- Python 3.8.x 64-bit
- Python 3.7.x 64-bit
- Python 3.6.x 64-bit
Then verify that you have pip 9.01 or higher available in your PATH:
python -c "import platform; print(platform.architecture())"
python -m pip --version
Assuming the prerequisite software is installed on your Windows, take the following steps:
python3 -m pip install -U --user ortools
Or, to install it system wide:
sudo python3 -m pip install -U ortools
To uninstall OR-Tools, issue the following commands:
python3 -m pip uninstall ortools
Get the Python example code
The example code is located in the python_or-tools repo.
Download the repo as a zip file and unzip it, or clone the repo:
git clone -b v9.5 --depth 1 https://github.com/or-tools/python_or-tools
Change to the examples directory:
Run the example
Run the binary using:
Congratulations! You've just run an application with OR-Tools, you are ready to get started with OR-Tools.