Welcome to tutor-planner!

Welcome to the documentation of the tutor planner. The tutor planner is a tool used by Internet Network Architectures (INET) of Technische Universität Berlin (TU Berlin) for the module Einführung in die Programmierung (introduction to programming). The module contains a two-week course to introduce new students in programming in C. Each day is filled with lectures, tutorials and computer exercises. This project is used for assigning the tutors to the tasks.

For the course, the tutor planner has a list of tutors, room bookings, target plans and much more information. The project contains a planner that is using Gurobi, a optimization solver for linear programming, to optimize the tutor plans.

The plans can be exported to overall and individual tutor plans, room plans and student tickets.

If you are new to the tutor planner, you might want to look at Getting started. If you are searching for the usage of the planner, you should read Command line interface.

Contents

• Getting started
• Installation
  • Setting up a virtual environment
  • Installation of tutor-planner
• Command line interface
  • List of commands
• Settings file
  • Course leaders file
  • Room patterns
• Tutor information
• Room bookings from LSF
  • Parsing details
• Room bookings from CSV and XLSX
• Creating a target plan
• Planning
  • Initial planning
  • Rolling wave planning
• Generated plans
• Plan states
  • Show state
  • Create a working copy
  • Activate working plan
  • Activate parent plan
• Manual updates
  • Add a task
  • Remove a task
  • Switch a task
  • Undo the last change
• Output plans and other stuff as PDF

API

• Data
• Plan
• Rooms
• LSF Parser
• Tutor
• Settings
• Converter
• Read pickled files
• Planning
  • Base
  • Initial planning
  • Rolling wave planning
• Gurobi interface
  • Base planner
  • Initial planner
  • Rolling wave planner
  • Gurobi status
• Update plan
• Output
  • Rendering functions
  • Helper functions

Contributors

• Matthias Rost <mrost AT inet.tu-berlin.de>
• Alexander Elvers <aelvers AT inet.tu-berlin.de>
• Elias Döhne <edoehne AT inet.tu-berlin.de>

• Module Index