timefold-quickstarts icon indicating copy to clipboard operation
timefold-quickstarts copied to clipboard

Get started with Timefold quickstarts here. Timefold is the successor of OptaPlanner, by the OptaPlanner team. Optimize the vehicle routing problem, employee rostering, task assignment, maintenance sc...

= Timefold Quickstarts

Planning optimization made easy. + https://timefold.ai[timefold.ai]

== Overview of all Quickstarts

|=== |Use case quickstarts |Technology quickstarts

a|* <<vehicle-routing, Vehicle Routing>>

  • <<maintenance-scheduling, Maintenance scheduling>>
  • <<employee-scheduling, Employee Scheduling>>
  • <<food-packaging, Food packaging>>
  • <<order-picking, Order Picking>>
  • <<school-timetabling, School timetabling>>
  • <<facility-location-problem, Facility location problem>>
  • <<conference-scheduling, Conference Scheduling>>
  • <<bed-allocation-scheduling, Bed Allocation Scheduling>>
  • <<flight-crew-scheduling, Flight Crew Scheduling>>
  • <<meeting-scheduling, Meeting Scheduling>>

a|* link:hello-world/README.adoc[Java (Hello World)] (Java, Maven or Gradle)

  • link:use-cases/school-timetabling/README.adoc[Quarkus] (Java, Maven or Gradle, Quarkus)
  • link:technology/java-spring-boot/README.adoc[Spring Boot] (Java, Maven or Gradle, Spring Boot)
  • link:technology/kotlin-quarkus/README.adoc[Kotlin] (Kotlin, Maven, Quarkus) |===

== Use cases

=== Vehicle Routing

Find the most efficient routes for vehicles to reach visits, taking into account vehicle capacity and time windows when visits are available. Sometimes also called "CVRPTW".

image::use-cases/vehicle-routing/quarkus-vehicle-routing-screenshot.png[]

  • link:use-cases/vehicle-routing/README.adoc[Run quarkus-vehicle-routing] (Java, Maven, Quarkus)

=== Maintenance scheduling

Schedule maintenance jobs to crews over time to reduce both premature and overdue maintenance.

image::use-cases/maintenance-scheduling/quarkus-maintenance-scheduling-screenshot.png[]

  • link:use-cases/maintenance-scheduling/README.adoc[Run quarkus-maintenance-scheduling] (Java, Maven, Quarkus)

=== Employee Scheduling

Schedule shifts to employees, accounting for employee availability and shift skill requirements.

image::use-cases/employee-scheduling/quarkus-employee-scheduling-screenshot.png[]

  • link:use-cases/employee-scheduling/README.adoc[Run quarkus-employee-scheduling] (Java, Maven, Quarkus)

=== Food Packaging

Schedule food packaging orders to manufacturing lines, to minimize downtime and fulfill all orders in time.

image::use-cases/food-packaging/quarkus-food-packaging-screenshot.png[]

  • link:use-cases/food-packaging/README.adoc[Run quarkus-food-packaging] (Java, Maven, Quarkus)

=== Order Picking

Generate an optimal picking plan for completing a set of orders.

image::use-cases/order-picking/quarkus-order-picking-screenshot.png[]

  • link:use-cases/order-picking/README.adoc[Run quarkus-order-picking] (Java, Maven, Quarkus)

=== School timetabling

Assign lessons to timeslots and rooms to produce a better schedule for teachers and students.

image::use-cases/school-timetabling/quarkus-school-timetabling-screenshot.png[]

  • link:use-cases/school-timetabling/README.adoc[Run quarkus-school-timetabling] (Java, Maven or Gradle, Quarkus)
  • link:technology/java-spring-boot/README.adoc[Run spring-boot-school-timetabling] (Java, Maven or Gradle, Spring Boot)
  • link:technology/kotlin-quarkus/README.adoc[Run kotlin-quarkus-school-timetabling] (Kotlin, Maven, Quarkus)

Without a UI:

  • link:hello-world/README.adoc[Run hello-world-school-timetabling] (Java, Maven or Gradle)

=== Facility location problem

Pick the best geographical locations for new stores, distribution centers, covid test centers or telco masts.

image::use-cases/facility-location/quarkus-facility-location-screenshot.png[]

  • link:use-cases/facility-location/README.adoc[Run quarkus-facility-location] (Java, Maven, Quarkus)

=== Conference Scheduling

Assign conference talks to timeslots and rooms to produce a better schedule for speakers.

image::use-cases/conference-scheduling/quarkus-conference-scheduling-screenshot.png[]

  • link:use-cases/conference-scheduling/README.adoc[Run quarkus-conference-scheduling] (Java, Maven, Quarkus)

=== Bed Allocation Scheduling

Assign beds to patient stays to produce a better schedule for hospitals.

image::use-cases/bed-allocation/quarkus-bed-scheduling-screenshot.png[]

  • link:use-cases/bed-allocation/README.adoc[Run quarkus-bed-allocation-scheduling] (Java, Maven, Quarkus)

=== Flight Crew Scheduling

Assign crew to flights to produce a better schedule for flight assignments.

image::use-cases/flight-crew-scheduling/quarkus-flight-crew-scheduling-screenshot.png[]

  • link:use-cases/flight-crew-scheduling/README.adoc[Run quarkus-flight-crew-scheduling] (Java, Maven, Quarkus)

=== Meeting Scheduling

Assign timeslots and rooms for meetings to produce a better schedule.

image::use-cases/meeting-scheduling/quarkus-meeting-scheduling-screenshot.png[]

  • link:use-cases/meeting-scheduling/README.adoc[Run quarkus-flight-crew-scheduling] (Java, Maven, Quarkus)

== Legal notice

Timefold Quickstarts was https://timefold.ai/blog/2023/optaplanner-fork/[forked] on 20 April 2023 from OptaPlanner Quickstarts, which was entirely Apache-2.0 licensed (a permissive license).

Timefold Quickstarts is a derivative work of OptaPlanner Quickstarts, which includes copyrights of the original creator, Red Hat Inc., affiliates and contributors, that were all entirely licensed under the Apache-2.0 license. Every source file has been modified.