Pumpkin is a combinatorial optimisation solver developed by the ConSol Lab at TU Delft. It is based on the (lazy clause generation) constraint programming paradigm.
This repository contains a modified version of Pumpkin that is used for the Constraint Solving course at TU Delft (CS4535).
Since Pumpkin is written in pure Rust, it is easy to install! After cloning, you can build the project using a version of Rust (1.72.1+) using the following commands:
cargo build # Creates a non-optimized build with debug info
cargo build --release # Creates an optimized buildPumpkin serves as a backend solver for the MiniZinc modelling language.
To use it as such a backend, follow the following steps:
- Step 1: Clone the repository and build it using
cargo build --release. - Step 2: Install MiniZinc using the appropriate executable or binary archive.
- Step 3: Add the following to the
MZN_SOLVER_PATHenvironment variable:<path_to_pumpkin>/minizinc(see this thread on how to do this using a shell). - Step 4: Check whether the installation worked using the command
minizinc --help pumpkin.
Pumpkin consists of 3 different crates:
- The library contained in core; defines the API through which the solver can be used via Rust.
- The CLI contained in pumpkin-solver; defines the usage of Pumpkin through a command line.
- The proof logging contained in drcp-format; defines proof logging which can be used in combination with Pumpkin.
- The python bindings contained in pumpkin-solver-py; defines the python interface for Pumpkin
The easiest way to get to know the different modules is through the documentation. This documentation can be created automatically using the command:
cargo doc --no-depsThere are several examples of how to use the solver specified in the documentation of the different components. For more concrete examples of how to use Pumpkin to solve a set of example problems, we refer to the examples folder which contains examples such as bibd, nqueens, and disjunctive scheduling.
One of the development goals of Pumpkin is to ensure that the solver is easy-to-use and well-documented. To this end, it is required that any external contribution is well-documented (both the structs/enums/methods and the implementation itself)!
To make use of these formatting rules, we require the nightly toolchain. Note that we only use the nightly toolchain for formatting. The nightly version which can be installed using the following command:
rustup toolchain install --component rustfmt -- nightlyThe formatting can then be run using:
cargo +nightly fmt