Skip to content

README.md

Latest commit

 

History

History
124 lines (85 loc) · 4.01 KB

README.md

File metadata and controls

124 lines (85 loc) · 4.01 KB

Vehicle Routing with time windows and capacity planning (Java, Quarkus, Maven)

Find the most efficient routes for a fleet of vehicles.

Vehicle Routing Screenshot

Constraints

Name Level Description
Vehicle capacity Hard The total demand of all visits assigned to a vehicle must not exceed its capacity.
Service finished after max end time Hard A visit must be serviced before its maximum end time.
Maximize visits assigned Medium As many visits as possible should be assigned to a vehicle.
Minimize travel time Soft Minimize the total travel time of all vehicles.

Tip

Check out our off-the-shelf model for Field Service Routing. This model goes beyond basic Vehicle Routing and supports additional constraints such as priorities, skills, fairness and more.

Prerequisites

  1. Install Java and Maven, for example with Sdkman: 
    $ sdk install java
$ sdk install maven

Run the application

  1. Git clone the timefold-quickstarts repo and navigate to this directory:

    $ git clone https://github.com/TimefoldAI/timefold-quickstarts.git
...
$ cd timefold-quickstarts/java/vehicle-routing

  2. (Optional) If you want to run a licensed edition (Plus / Enterprise), set up your license key first. See the Timefold license tool for instructions.

  3. Start the application with Maven:

    1. Community Edition

      $ mvn quarkus:dev

    2. Plus / Enterprise Edition: The profile sets up the correct Maven artifacts to run the licensed version. See the pom.xml for the implementation details.

      $ mvn quarkus:dev -Denterprise

  4. Visit http://localhost:8080 in your browser.

  5. Click on the Solve button.

Then try live coding:

  • Make some changes in the source code.
  • Refresh your browser (F5).
  • Notice that those changes are immediately visible.

Run the packaged application

When you're done iterating in quarkus:dev mode, package the application to run as a conventional jar file.

  1. Compile it with Maven:

    $ mvn package

  2. Run it:

    $ java -jar ./target/quarkus-app/quarkus-run.jar

    Note
    To run it on port 8081 instead, add -Dquarkus.http.port=8081.

  3. Visit http://localhost:8080 in your browser.

  4. Click on the Solve button.

Run the application in a container

  1. Build a container image:

    $ mvn package -Dcontainer

    The container image name

  2. Run a container:

    $ docker run -p 8080:8080 --rm $USER/vehicle-routing:1.0-SNAPSHOT

Run it native

To increase startup performance for serverless deployments, build the application as a native executable:

  1. Install GraalVM and gu install the native-image tool.

  2. Compile it natively.
    This takes a few minutes:

    $ mvn package -Dnative

  3. Run the native executable:

    $ ./target/*-runner

  4. Visit http://localhost:8080 in your browser.

  5. Click on the Solve button.

More information

Visit timefold.ai.