Skip to content

BasicQuam API

BasicFEMQuam

Bases: BasicQuam

Basic QUAM root component for FEM (Frequency Encoded Multiplexing) systems.

Extends BasicQuam with FEM-specific port configurations for quantum control hardware.

Attributes:

Name Type Description
ports FEMPortsContainer

Container for FEM-specific analog and digital ports.
Source code in quam/components/basic_quam.py 
31
32
33
34
35
36
37
38
39
40
41
@quam_dataclass
class BasicFEMQuam(BasicQuam):
    """Basic QUAM root component for FEM (Frequency Encoded Multiplexing) systems.

    Extends BasicQuam with FEM-specific port configurations for quantum control hardware.

    Attributes:
        ports (FEMPortsContainer): Container for FEM-specific analog and digital ports.
    """

    ports: FEMPortsContainer = field(default_factory=FEMPortsContainer)

BasicOPXPlusQuam

Bases: BasicQuam

Basic QUAM root component for OPX+ systems.

Extends BasicQuam with OPX+-specific port configurations for quantum control hardware.

Attributes:

Name Type Description
ports OPXPlusPortsContainer

Container for OPX+ analog and digital ports.
Source code in quam/components/basic_quam.py 
44
45
46
47
48
49
50
51
52
53
54
@quam_dataclass
class BasicOPXPlusQuam(BasicQuam):
    """Basic QUAM root component for OPX+ systems.

    Extends BasicQuam with OPX+-specific port configurations for quantum control hardware.

    Attributes:
        ports (OPXPlusPortsContainer): Container for OPX+ analog and digital ports.
    """

    ports: OPXPlusPortsContainer = field(default_factory=OPXPlusPortsContainer)

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 
16
17
18
19
20
21
22
23
24
25
26
27
28
@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)