API Reference

The QMI framework consists of several Python 3 packages and modules.

Hint

In Python, a package corresponds to a directory, whereas a module normally corresponds to a Python source file. The QMI framework is itself a package (directory), containing several sub-packages (subdirectories) and also modules (files ending in .py). Classes and functions are normally defined in the module files.

The confusing part is that, technically, packages are themselves also modules, and contain the classes and functions defined in the file __init__.py that resides in their directory.

QMI package overview

The QMI main package:

qmi	Toplevel package of the QMI framework.

The QMI framework consists of the following sub-packages:

qmi.core	Core functionality of the QMI framework.
qmi.data	QMI functionality for writing and reading data files.
qmi.instruments	QMI drivers for a variety of instruments, driver packages by vendor.
qmi.tools	Tools for QMI.
qmi.utils	Utility programs for QMI.

Click on the package name to see more details.