BasicQuAM API

BasicQuAM

Bases: QuamRoot

Basic top-level QuAM root component.

If custom QuAM components are used, a custom QuAM root component should be created.

Parameters:

Name	Type	Description	Default
channels	Dict[str, Channel]	A dictionary of channels.	required
octaves	Dict[str, Octave]	A dictionary of octaves.	required

Source code in quam/components/basic_quam.py

@quam_dataclass
class BasicQuAM(QuamRoot):
    """Basic top-level QuAM root component.

    If custom QuAM components are used, a custom QuAM root component should be created.

    Args:
        channels (Dict[str, Channel], optional): A dictionary of channels.
        octaves (Dict[str, Octave], optional): A dictionary of octaves.
    """

    channels: Dict[str, Channel] = field(default_factory=dict)
    octaves: Dict[str, Octave] = field(default_factory=dict)