pyjobshop 0.0.2rc0

Solving scheduling problems with constraint programming.

[!NOTE] This package is under development. Expect things to break significantly in versions v0.0.*.

PyJobShop is a Python library for solving scheduling problems with constraint programming. It currently supports the following scheduling problems:

• Resource environments: single machines, parallel machines, hybrid flow shops, open shops, job shops, flexible job shops, renewable resources and non-renewable resources.
• Constraints: release dates, deadlines, due dates, multiple modes, sequence-dependent setup times, no-wait, blocking, and precedence constraints.
• Objective functions: minimizing makespan, total flow time, number of tardy jobs, total tardiness, and total earliness.

You can find PyJobShop on the Python Package Index under the name pyjobshop. To install it, simply run:

pip install pyjobshop

The documentation is available here.

[!TIP] If you are new to scheduling or constraint programming, you might benefit from first reading the introduction to scheduling and introduction to constraint programming pages.

Constraint programming solvers

PyJobShop uses OR-Tools' CP-SAT solver as its default constraint programming solver. We also support CP Optimizer - see our documentation for instructions on how to install PyJobShop with CP Optimizer.

Examples

We provide example notebooks that show how PyJobShop may be used to solve scheduling problems.

• A short tutorial and introduction to PyJobShop's modeling interface, available here. This is a great way to get started with PyJobShop.
• Notebooks solving the classical machine scheduling problems such as the hybrid flow shop (here) and the flexible job shop problem (here).
• A notebook showing how to solve different project scheduling problems, here.

Contributing

We are very grateful for any contributions you are willing to make. Please have a look here to get started. If you aim to make a large change, it is helpful to discuss the change first in a new GitHub issue. Feel free to open one!

Getting help

Feel free to open an issue or a new discussion thread here on GitHub. Please do not e-mail us with questions, modelling issues, or code examples. Those are much easier to discuss via GitHub than over e-mail. When writing your issue or discussion, please follow the instructions here.