63 lines
1.5 KiB
Markdown
63 lines
1.5 KiB
Markdown
# Introduction
|
|
|
|
This file describes how to use OR-Tools in python with the binary archives.
|
|
|
|
OR-Tools online documentation is located at https://developers.google.com/optimization
|
|
|
|
Full installation instructions are located at https://developers.google.com/optimization/install/python/
|
|
|
|
These modules have been tested under:
|
|
|
|
- CentOS 7 LTS and Stream 8 (64 bit).
|
|
- Debian 10 and 11 (64 bit).
|
|
- Fedora 33 and up (64 bit).
|
|
- Opensuse Leap (64 bit).
|
|
- Ubuntu 18.04 LTS and up (64 bit).
|
|
- MacOS 12.5 Monterey (64 bit).
|
|
- Microsoft Windows with Visual Studio 2019 and 2022 (64-bit)
|
|
|
|
## Codemap
|
|
|
|
Upon decompressing the archive, you will get the following structure:
|
|
|
|
```
|
|
or-tools/
|
|
[LICENSE](LICENSE) <- Apache License.
|
|
[README.md](README.md) <- This file.
|
|
[examples/python](examples/python) <- Python examples.
|
|
[examples/notebook](examples/notebook) <- Jupyter/IPython notebooks.
|
|
```
|
|
|
|
Warning: While OR-Tools ships with SCIP, please consult the SCIP license
|
|
to ensure that you are complying with it if you want to use this solver.
|
|
|
|
## Installation
|
|
|
|
To install the package:
|
|
|
|
1. Make sure python and pip are installed
|
|
|
|
2. Make sure pip is up to date:
|
|
|
|
```shell
|
|
python -m pip -V
|
|
```
|
|
|
|
should return 9.0.1 otherwise, run: `python -m pip install --upgrade --user pip`
|
|
|
|
3. Fetch `ortools` from Pypi:
|
|
|
|
```shell
|
|
python -m pip install --upgrade --user ortools
|
|
```
|
|
|
|
It should pull the latest version of OR-Tools.
|
|
|
|
## Usage
|
|
|
|
To run a first example:
|
|
|
|
```shell
|
|
python examples/python/hidato_table.py
|
|
```
|