Timefold quickstarts

<p align="center"> <a href="https://solver.timefold.ai"> <img src="/timefold-solver-logo.png" width="400px" alt="Timefold Solver" /> </a> </p>

This repository contains quickstarts for Timefold Solver, an AI constraint solver for Java and Kotlin.
It shows different use cases and basic implementations to get you started on your PlanningAI journey.

Overview

Use Case	Notable Solver Concepts
🚚 <a href="#-vehicle-routing">Vehicle Routing</a>	Chained Through Time, Shadow Variables
🧑‍💼 <a href="#-employee-scheduling">Employee Scheduling</a>	Load Balancing
🛠️ <a href="#-maintenance-scheduling">Maintenance Scheduling</a>	TimeGrain, Shadow Variable, Variable Listener
📦 <a href="#-food-packaging">Food Packaging</a>	Mixed Model, Shadow Variables, Pinning
🛒 <a href="#-order-picking">Order Picking</a>	Chained Planning Variable, Shadow Variables
🏫 <a href="#-school-timetabling">School Timetabling</a>	Timeslot
🏭 <a href="#-facility-location-problem">Facility Location Problem</a>	Shadow Variable
🎤 <a href="#-conference-scheduling">Conference Scheduling</a>	Timeslot, Justifications
🛏️ <a href="#-bed-allocation-scheduling">Bed Allocation Scheduling</a>	Allows Unassigned
🛫 <a href="#-flight-crew-scheduling">Flight Crew Scheduling</a>
👥 <a href="#-meeting-scheduling">Meeting Scheduling</a>	TimeGrain
✅ <a href="#-task-assigning">Task Assigning</a>	Bendable Score, Chained Through Time, Allows Unassigned
📆 <a href="#-project-job-scheduling">Project Job Scheduling</a>	Shadow Variables, Variable Listener, Strenght Comparator
🏆 <a href="#-sports-league-scheduling">Sports League Scheduling</a>	Consecutive Sequences
🏅 <a href="#-tournament-scheduling">Tournament Scheduling</a>	Pinning, Load Balancing

[!NOTE]
The implementations in this repository serve as a starting point and/or inspiration when creating your own application.
Timefold Solver is a library and does not include a UI. To illustrate these use cases a rudimentary UI is included in these quickstarts.

Use cases

🚚 Vehicle Routing

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

• View constraints
• Run quarkus-vehicle-routing (Java, Maven, Quarkus)

[!TIP]
<img src="https://docs.timefold.ai/_/img/models/field-service-routing.svg" align="right" width="50px" /> 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.

---

🧑‍💼 Employee Scheduling

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

• View constraints
• Run quarkus-employee-scheduling (Java, Maven, Quarkus)

[!TIP]
<img src="https://docs.timefold.ai/_/img/models/employee-shift-scheduling.svg" align="right" width="50px" /> Check out our off-the-shelf model for Employee Shift Scheduling. This model supports many additional constraints such as skills, pairing employees, fairness and more.

---

🛠️ Maintenance Scheduling

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

• View constraints
• Run quarkus-maintenance-scheduling (Java, Maven, Quarkus)

---

📦 Food Packaging

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

• View constraints
• Run quarkus-food-packaging (Java, Maven, Quarkus)

---

🛒 Order Picking

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

• View constraints
• Run quarkus-order-picking (Java, Maven, Quarkus)

---

🏫 School Timetabling

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

• View constraints
• Run quarkus-school-timetabling (Java, Maven or Gradle, Quarkus)
• Run spring-boot-integration (Java, Maven or Gradle, Spring Boot)
• Run kotlin-quarkus-school-timetabling (Kotlin, Maven, Quarkus)

Without a UI:

• 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 telecom masts.

• View constraints
• Run quarkus-facility-location (Java, Maven, Quarkus)

---

🎤 Conference Scheduling

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

• View constraints
• Run quarkus-conference-scheduling (Java, Maven, Quarkus)

---

🛏️ Bed Allocation Scheduling

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

• View constraints
• Run quarkus-bed-allocation-scheduling (Java, Maven, Quarkus)

---

🛫 Flight Crew Scheduling

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

• View constraints
• Run quarkus-flight-crew-scheduling (Java, Maven, Quarkus)

---

👥 Meeting Scheduling

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

• View constraints
• Run quarkus-meeting-scheduling (Java, Maven, Quarkus)

---

✅ Task Assigning

Assign employees to tasks to produce a better plan for task assignments.

• View constraints
• Run quarkus-task-assigning (Java, Maven, Quarkus)

---

📆 Project Job Scheduling

Assign jobs for execution to produce a better schedule for project job allocations.

• View constraints
• Run quarkus-project-job-scheduling (Java, Maven, Quarkus)

---

🏆 Sports League Scheduling

Assign rounds to matches to produce a better schedule for league matches.

• View constraints
• Run quarkus-sports-league-scheduling (Java, Maven, Quarkus)

---

🏅 Tournament Scheduling

Tournament Scheduling service assigning teams to tournament matches.

• View constraints
• Run quarkus-tournament-scheduling (Java, Maven, Quarkus)

---

Legal notice

Timefold Quickstarts was 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.