From 23be0f085543c8fa9ff5e8fb42ea694230caeb37 Mon Sep 17 00:00:00 2001 From: Serwan Asaad Date: Mon, 6 May 2024 15:54:43 +0200 Subject: [PATCH] docs: add FrequencyConverter --- docs/components/quam-root.md | 2 +- quam/components/hardware.py | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/components/quam-root.md b/docs/components/quam-root.md index a47ff205..e986b7c7 100644 --- a/docs/components/quam-root.md +++ b/docs/components/quam-root.md @@ -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 diff --git a/quam/components/hardware.py b/quam/components/hardware.py index cc989c07..ff09c814 100644 --- a/quam/components/hardware.py +++ b/quam/components/hardware.py @@ -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