2020-09-25 17:45:25 +02:00
|
|
|
# Introduction
|
2020-12-05 23:17:55 +01:00
|
|
|
|
2020-09-25 17:45:25 +02:00
|
|
|
This file describes how to use OR-Tools in Java with the binary archives.
|
|
|
|
|
|
2022-03-28 18:29:33 +02:00
|
|
|
OR-Tools online documentation is located at https://developers.google.com/optimization
|
2020-09-25 17:45:25 +02:00
|
|
|
|
2022-03-28 18:29:33 +02:00
|
|
|
Full installation instructions are located at https://developers.google.com/optimization/install/java/
|
2020-09-25 17:45:25 +02:00
|
|
|
|
|
|
|
|
These modules have been tested under:
|
2020-12-05 23:17:55 +01:00
|
|
|
|
2022-03-28 18:29:33 +02:00
|
|
|
- CentOS 7 LTS and Stream 8 (64 bit).
|
|
|
|
|
- Debian 10 and 11 (64 bit).
|
2022-03-10 14:03:26 +01:00
|
|
|
- Fedora 33 and up (64 bit).
|
2022-03-28 18:29:33 +02:00
|
|
|
- Opensuse Leap (64 bit).
|
2022-03-10 14:03:26 +01:00
|
|
|
- Ubuntu 18.04 LTS and up (64 bit).
|
2022-08-05 17:37:24 +02:00
|
|
|
- MacOS 12.5 Monterey (64 bit).
|
2022-03-28 18:29:33 +02:00
|
|
|
- Microsoft Windows with Visual Studio 2019 and 2022 (64-bit)
|
|
|
|
|
|
|
|
|
|
## Codemap
|
2020-09-25 17:45:25 +02:00
|
|
|
|
|
|
|
|
Upon decompressing the archive, you will get the following structure:
|
2020-12-05 23:17:55 +01:00
|
|
|
|
2020-09-25 17:45:25 +02:00
|
|
|
```
|
|
|
|
|
or-tools/
|
2022-03-28 18:29:33 +02:00
|
|
|
[LICENSE](LICENSE) <- Apache License.
|
|
|
|
|
[README.md](README.md) <- This file.
|
|
|
|
|
[examples](examples) <- Java examples.
|
|
|
|
|
[Makefile](Makefile) <- Main Makefile for Java.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Running the examples will involve compiling them, then running them.
|
|
|
|
|
We have provided a makefile target to help you.
|
|
|
|
|
|
|
|
|
|
Use Makefile:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
make run SOURCE=examples/BasicExample/BasicExample.java
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To build an example, open the folder in the command prompt and type the following commands:
|
|
|
|
|
|
|
|
|
|
**OR** this is equivalent to compiling and running
|
|
|
|
|
`examples/BasicExample/BasicExample.java`.
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
cd examples/BasicExample
|
|
|
|
|
mvn compile -B
|
|
|
|
|
mvn run
|
2020-09-25 17:45:25 +02:00
|
|
|
```
|