qcdrivers 0.1.0__py3-none-any.whl

qcdrivers/__init__.py

@@ -0,0 +1,9 @@
+"""
+QCoDeS drivers for instruments used in the SQUAD lab.
+
+Drivers are grouped by manufacturer; hardware-triggered (buffered) sweep nodes
+live under :mod:`qcdrivers.buffered`, grouped the same way.
+
+"""
+
+__all__: list[str] = []

qcdrivers/basel/__init__.py

@@ -0,0 +1,12 @@
+"""Basel Precision Instruments drivers."""
+
+from qcdrivers.basel.amplifiers import BaselSP1004a, DummyBaselSP983a, DummyBaselSP1004a
+from qcdrivers.basel.dacs import BaselDac2, BaselDac2Controller
+
+__all__ = [
+    "BaselDac2",
+    "BaselDac2Controller",
+    "BaselSP1004a",
+    "DummyBaselSP1004a",
+    "DummyBaselSP983a",
+]

qcdrivers/basel/amplifiers/__init__.py

@@ -0,0 +1,10 @@
+"""Basel Precision Instruments preamplifiers."""
+
+from qcdrivers.basel.amplifiers.amplifiers import BaselSP1004a
+from qcdrivers.basel.amplifiers.dummy import DummyBaselSP983a, DummyBaselSP1004a
+
+__all__ = [
+    "BaselSP1004a",
+    "DummyBaselSP1004a",
+    "DummyBaselSP983a",
+]

qcdrivers/basel/amplifiers/amplifiers.py

@@ -0,0 +1,107 @@
+from typing import Any, Optional
+
+import numpy as np
+from qcodes import validators as vals
+from qcodes.instrument import VisaInstrument
+
+
+class BaselSP1004a(VisaInstrument):
+    """
+    A driver for Basel Preamp's (SP1004a) Remote Instrument - Model SP1004a.
+
+    Args:
+        name: name for your instrument driver instance
+        address: address of the connected remote controller of basel preamp
+    """
+
+    def __init__(
+        self,
+        name: str,
+        address: str,
+        terminator: str = "\r\n",
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(name, address, terminator=terminator, **kwargs)
+
+        self.connect_message()
+
+        self.add_parameter(
+            "gain",
+            label="Gain",
+            unit="",
+            set_cmd=self._set_gain,
+            get_cmd=self._get_gain,
+            vals=vals.Enum(1e2, 1e3, 1e4),
+        )
+        self.add_parameter(
+            "fcut",
+            unit="Hz",
+            label="Filter Cut-Off Frequency",
+            get_cmd=self._get_filter,
+            get_parser=self._parse_filter_value,
+            set_cmd=self._set_filter,
+            val_mapping={
+                100: "100",
+                300: "300",
+                1000: "1k",
+                3000: "3k",
+                10e3: "10k",
+                30e3: "30k",
+                100e3: "100k",
+                300e3: "300k",
+                1e6: "FULL",
+            },
+        )
+        self.add_parameter(
+            "overload_status", label="Overload Status", set_cmd=False, get_cmd="GET O"
+        )
+
+        self.add_parameter(
+            "vin_offset_compensated",
+            label="Overload Status",
+            set_cmd=False,
+            get_cmd="GET C",
+        )
+
+    def get_idn(self) -> dict[str, Optional[str]]:
+        vendor = "Physics Basel"
+        model = "SP 1004A"
+        serial = None
+        firmware = None
+        return {
+            "vendor": vendor,
+            "model": model,
+            "serial": serial,
+            "firmware": firmware,
+        }
+
+    def _set_gain(self, value: float) -> None:
+        r = self.ask(f"SET G 1E{int(np.log10(value))}")
+        if r != "OK":
+            raise ValueError(f"Expected OK return but got: {r}")
+
+    def _get_gain(self) -> float:
+        s = self.ask("GET G")
+        r = s.split("Gain: ")[1]
+        return float(r)
+
+    def _set_filter(self, value: str) -> None:
+        r = self.ask(f"SET F {value}")
+        if r != "OK":
+            raise ValueError(f"Expected OK return but got: {r}")
+
+    def _get_filter(self) -> str:
+        s = self.ask("GET F")
+        return s.split("Filter: ")[1]
+
+    @staticmethod
+    def _parse_filter_value(val: str) -> str:
+        if val.startswith("F"):
+            return "FULL"
+        elif val[-3::] == "kHz":
+            return str(int(val[0:-3])) + "k"
+
+        elif val[-2::] == "Hz":
+            return str(int(val[0:-2]))
+        else:
+            raise ValueError(f"Could not interpret result. Got: {val}")

qcdrivers/basel/amplifiers/dummy.py

@@ -0,0 +1,136 @@
+"""
+Dummy Basel preamplifier instruments.
+
+Software stand-ins for the Basel SP1004a and SP983a preamplifiers, for wiring
+up a measurement without the hardware present. Moved here from
+``qcdrivers.squad.helpers.helpers`` so that Basel instruments live under the
+Basel manufacturer package.
+
+"""
+
+from typing import Any, Optional
+
+from qcodes import validators as vals
+from qcodes.instrument import Instrument
+
+__all__ = ["DummyBaselSP1004a", "DummyBaselSP983a"]
+
+
+class DummyBaselSP1004a(Instrument):
+    """
+    A driver for Dummy Basel Diffamp's (SP1004a) Remote Instrument - Model SP1004a.
+
+    Args:
+        name: name for your instrument driver instance
+        address: address of the connected remote controller of basel preamp
+    """
+
+    def __init__(
+        self,
+        name: str,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(name, **kwargs)
+        self.gain_value = None
+        self.filter_value = None
+
+        self.add_parameter(
+            "gain",
+            label="Gain",
+            unit="",
+            set_cmd=self._set_gain,
+            get_cmd=self._get_gain,
+            vals=vals.Enum(1e2, 1e3, 1e4),
+        )
+        self.add_parameter(
+            "fcut",
+            unit="Hz",
+            label="Filter Cut-Off Frequency",
+            get_cmd=self._get_filter,
+            set_cmd=self._set_filter,
+            vals=vals.Enum(100, 300, 1000, 3000, 10e3, 30e3, 100e3, 300e3, 1e6),
+        )
+
+    def get_idn(self) -> dict[str, Optional[str]]:
+        vendor = "SQUAD Lab"
+        model = "Dummy SP 1004A"
+        serial = None
+        firmware = None
+        return {
+            "vendor": vendor,
+            "model": model,
+            "serial": serial,
+            "firmware": firmware,
+        }
+
+    def _set_gain(self, value: float) -> None:
+        self.gain_value = value
+
+    def _get_gain(self) -> float:
+        return self.gain_value
+
+    def _set_filter(self, value: str) -> None:
+        self.filter_value = value
+
+    def _get_filter(self) -> str:
+        return self.filter_value
+
+
+class DummyBaselSP983a(Instrument):
+    """
+    A driver for a Dummy Basel I/V Converter (SP983a) Remote Instrument - Model SP983a.
+
+    Args:
+        name: name for your instrument driver instance
+        address: address of the connected remote controller of basel preamp
+    """
+
+    def __init__(
+        self,
+        name: str,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(name, **kwargs)
+        self.gain_value = None
+        self.filter_value = None
+
+        self.add_parameter(
+            "gain",
+            label="Gain",
+            unit="",
+            set_cmd=self._set_gain,
+            get_cmd=self._get_gain,
+            vals=vals.Enum(1e5, 1e6, 1e7, 1e8, 1e9),
+        )
+        self.add_parameter(
+            "fcut",
+            unit="Hz",
+            label="Filter Cut-Off Frequency",
+            get_cmd=self._get_filter,
+            set_cmd=self._set_filter,
+            vals=vals.Enum(30, 100, 300, 1000, 3000, 10e3, 30e3, 100e3, 1e6),
+        )
+
+    def get_idn(self) -> dict[str, Optional[str]]:
+        vendor = "SQUAD Lab"
+        model = "Dummy SP 983a"
+        serial = None
+        firmware = None
+        return {
+            "vendor": vendor,
+            "model": model,
+            "serial": serial,
+            "firmware": firmware,
+        }
+
+    def _set_gain(self, value: float) -> None:
+        self.gain_value = value
+
+    def _get_gain(self) -> float:
+        return self.gain_value
+
+    def _set_filter(self, value: str) -> None:
+        self.filter_value = value
+
+    def _get_filter(self) -> str:
+        return self.filter_value

qcdrivers/basel/dacs/__init__.py

@@ -0,0 +1,9 @@
+"""Basel Precision Instruments DACs."""
+
+from qcdrivers.basel.dacs.dacs import BaselDac2
+from qcdrivers.basel.dacs.dacs_controller import BaselDac2Controller
+
+__all__ = [
+    "BaselDac2",
+    "BaselDac2Controller",
+]