Skip to content

Commit

Permalink
docs: add FrequencyConverter
Browse files Browse the repository at this point in the history
  • Loading branch information
nulinspiratie committed May 6, 2024
1 parent 72d47c7 commit 23be0f0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/components/quam-root.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Quantum Abstract Machine (QuAM) utilizes a hierarchical data structure in wh

## Overview

The root QuAM object is structured as a subclass of [QuamRoot](quam.core.quam_classes.QuamRoot) module. For straightforward implementations, such as those described in the [Migrating to QuAM](migrating-to-quam) section, the [BasicQuAM][quam.components.basic_quam.BasicQuAM] class typically suffices:
The root QuAM object is structured as a subclass of [QuamRoot][quam.core.quam_classes.QuamRoot] module. For straightforward implementations, such as those described in the [Migrating to QuAM](/migrating-to-quam) section, the [BasicQuAM][quam.components.basic_quam.BasicQuAM] class typically suffices:

```python
from quam.components import BasicQuAM
Expand Down
16 changes: 16 additions & 0 deletions quam/components/hardware.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,22 @@ class BaseFrequencyConverter(QuamComponent):

@quam_dataclass
class FrequencyConverter(BaseFrequencyConverter):
"""Frequency up/down converter component.
This component encapsulates the local oscillator and mixer used to upconvert or
downconvert an RF signal.
The FrequencyConverter component is attached to IQ channels through
- `IQChannel.frequency_converter_up`
- `InOutIQChannel.frequency_converter_down`
Args:
local_oscillator (LocalOscillator): The local oscillator for the frequency converter.
mixer (Mixer): The mixer for the frequency converter.
gain (float): The gain of the frequency converter.
"""

local_oscillator: LocalOscillator = None
mixer: Mixer = None
gain: float = None
Expand Down

0 comments on commit 23be0f0

Please sign in to comment.