QToolKit is still in beta phase. The API may change at any time.

QToolKit documentation#

Version: 0.1.4

QToolKit is an interface to Distributed Resource Management (DRM) systems, e.g. SLURM and PBS, with the aim to enable programmatic control of queuing systems.

Getting Started

If you want to get started quickly, check out our quickstart section. It contains an introduction to QToolKit’s main concepts.

User Guide

The user guide provides in-depth information on the key concepts of QToolKit with useful background information and explanation.

API Reference

The reference guide contains a detailed description of the functions, modules, and objects included in QToolKit. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.

Contributor’s Guide

Want to add to the codebase? Can help add support to an additional DRM system? The contributing guidelines will guide you through the process of improving QToolKit.