qat.engines.model module

class RequiresHardwareModelMixin

Bases: ABC

Specifies a hardware model requirement for a NativeEngine. To be used as a mixin for engines that require a hardware model to be set.

Engines might require a hardware model to be set to execute. This might be because the hardware model contains information about the control hardware of the target device (for the case of legacy hardware models), or because the engine is a simulator that makes use of the calibration data.

property model: PhysicalHardwareModel | QuantumHardwareModel

requires_hardware_model(engine)

Checks if an engine requires a hardware model. This is used to allow backwards compatibility with purr engines, but should be removed in the future.

Return type:

bool