This project generates a timetable given a set of inputs and constraints. It encodes constraints of the timetabling problem as a SAT formula in the Conjunctive Normal Form, and then calls a MaxSAT solver to solve the problem.


For Ubuntu/Debian users: Download the deb for the latest version of Timetabler from here and install it.

To build the project from source follow the steps below.


This project requires following tools to build.


The following software are dependencies for this program:

Get the code

The most recent stable release can be downloaded from here.

To get the latest code, use

1 $ git clone https://github.com/GoodDeeds/Timetabler
2 $ cd Timetabler

Setting up the dependencies

Short method

To set up all the dependencies required, simply run the following command

1 $ ./install_dependencies.sh

If building with tests, use instead

1 $ ./install_dependencies.sh --enable-tests

If the above command fails, you can try installing the individual dependencies manually by following the instructions below.

Long method

This describes the process of setting up each dependency.

Open WBO 2.1

This needs to be built as a library. The following steps need to be followed:


This does not require any setup other than cloning the repository. The path where this is cloned will be referred to as $CSVPARSER_PATH.


Building the project

If building with tests, set GTEST_PATH appropriately and use

1 $ mkdir build && cd build
2 $ cmake -DOPEN_WBO_PATH="../dependencies/open-wbo" -DYAML_CPP_PATH="../dependencies/yaml-cpp-yaml-cpp-0.6.2" -DCSVPARSER_PATH="../dependencies/CSVparser" -DPEGTL_PATH="../dependencies/PEGTL-2.7.0" -DGTEST_PATH="../dependencies/googletest-release-1.8.1" -DENABLE_TESTS=On ..
3 $ make timetabler

Running the Timetabler

To execute the program, use

1 $ timetabler fields.yml input.csv custom.txt output.csv


A detailed explanation on each file can be found in the Project Wiki.

Examples of Configuration files

Examples for configuration files can be found [here](examples). This contains some examples for the field information, the input, and custom constraints to be added to the solver.

For further details and examples, please refer to the Project Wiki.


If you have any queries, suggestions, or feature requests, or would like to report any bugs or issues, please open an issue on GitHub.

When reporting bugs, please provide sufficient information (such as the inputs and the configuration used) to reproduce the bug.


To contribute to this project, please send a pull request.


This software is provided under the [MIT License](LICENSE).