qcodes 0.62.0__tar.gz → 0.63.0__tar.gz

{qcodes-0.62.0/src/qcodes.egg-info → qcodes-0.63.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qcodes
-Version: 0.62.0
+Version: 0.63.0
 Summary: Python-based data acquisition framework developed by the Copenhagen / Delft / Sydney / Microsoft quantum computing consortium
 Maintainer-email: QCoDeS Core Developers <qcodes-support@microsoft.com>
 License-Expression: MIT
@@ -64,7 +64,7 @@ Requires-Dist: parso>=0.8.6; extra == "test"
 Requires-Dist: pytest>=8.2.0; extra == "test"
 Requires-Dist: pytest-asyncio>=0.24.0; extra == "test"
 Requires-Dist: pytest-cov>=5.0.0; extra == "test"
-Requires-Dist: pytest-mock>=3.13.0; extra == "test"
+Requires-Dist: pytest-mock>=3.14.0; extra == "test"
 Requires-Dist: pytest-rerunfailures>=14.0; extra == "test"
 Requires-Dist: pytest-xdist>=3.6.1; extra == "test"
 Requires-Dist: PyVisa-sim>=0.6.0; extra == "test"
@@ -75,8 +75,9 @@ Requires-Dist: types_requests>=0.1.8; extra == "test"
 Requires-Dist: types-tabulate>=0.1.0; extra == "test"
 Requires-Dist: types-tqdm>=4.64.6; extra == "test"
 Requires-Dist: types_pywin32>=305.0.0.7; extra == "test"
+Requires-Dist: typing_extensions>=4.16.0; extra == "test"
 Requires-Dist: qcodes_loop>=0.1.1; extra == "test"
-Requires-Dist: zhinst.qcodes>=0.5; python_version < "3.15" and extra == "test"
+Requires-Dist: zhinst.qcodes>=0.5; extra == "test"
 Requires-Dist: libcst>=1.2.0; extra == "test"
 Provides-Extra: docs
 Requires-Dist: autodocsumm>=0.2.9; extra == "docs"

{qcodes-0.62.0 → qcodes-0.63.0}/pyproject.toml

@@ -75,7 +75,7 @@ test = [
     "pytest>=8.2.0",
     "pytest-asyncio>=0.24.0",
     "pytest-cov>=5.0.0",
-    "pytest-mock>=3.13.0",
+    "pytest-mock>=3.14.0",
     "pytest-rerunfailures>=14.0",
     "pytest-xdist>=3.6.1",
     "PyVisa-sim>=0.6.0",
@@ -86,8 +86,9 @@ test = [
     "types-tabulate>=0.1.0",
     "types-tqdm>=4.64.6",
     "types_pywin32>=305.0.0.7",
+    "typing_extensions>=4.16.0", # Sentinel used in tests
     "qcodes_loop>=0.1.1",
-    "zhinst.qcodes>=0.5; python_version < '3.15'", # typecheck zhinst driver alias. zhinst-core has no Python 3.15 wheels yet
+    "zhinst.qcodes>=0.5",
     "libcst>=1.2.0", # refactor tests
 ]
 docs = [
@@ -180,13 +181,6 @@ module = [
 ]
 ignore_missing_imports = true
 
-# zhinst-qcodes is not installable on all Python versions we test
-# (no Python 3.15 wheels for zhinst-core yet). When it is installed,
-# the Zurich Instruments driver aliases are still typechecked against it.
-[[tool.mypy.overrides]]
-module = ["zhinst.*"]
-ignore_missing_imports = true
-
 [tool.pyright]
 include = ["src","tests"]
 ignore = [
@@ -216,13 +210,6 @@ reportUnnecessaryTypeIgnoreComment = "none"
 # but not type ignore comments since mypy already checks if type ignores are necessary
 reportUnnecessaryContains = "none"
 
-executionEnvironments = [
-  # zhinst-qcodes is not installable on all Python versions we test
-  # (no Python 3.15 wheels for zhinst-core yet). When it is installed,
-  # the Zurich Instruments driver aliases are still typechecked against it.
-  { root = "src/qcodes/instrument_drivers/zurich_instruments", reportMissingImports = "none" },
-]
-
 [tool.pytest.ini_options]
 minversion = "7.2"
 testpaths = "tests"
@@ -497,7 +484,7 @@ name = "Under the hood:"
 # we hard code the default version to match a development version
 # due to
 # https://github.com/orgs/community/discussions/163397#discussioncomment-13888710
-default-version = "0.54.0dev+Unknown"
+default-version = "0.63.0dev+Unknown"
 
 
 [tool.versioningit.format]

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/_version.py

@@ -13,4 +13,4 @@ def _get_version() -> str:
         return "0.0"
 
 
-__version__ = "0.62.0"
+__version__ = "0.63.0"

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/dataset/data_set.py

@@ -391,7 +391,13 @@ class DataSet(BaseDataSet):
         parent_datasets: Sequence[Mapping[Any, Any]] = (),
         write_in_background: bool = False,
     ) -> None:
-        self.add_snapshot(json.dumps(snapshot, cls=NumpyJSONEncoder))
+        """Prepare a run, committing its snapshot before starting observers.
+
+        Startup metadata and the snapshot are written atomically. The snapshot
+        is inserted after the other runs-row updates to avoid repeatedly
+        rewriting a potentially large payload.
+        """
+        snapshot_raw = json.dumps(snapshot, cls=NumpyJSONEncoder)
 
         if interdeps == InterDependencies_():
             raise RuntimeError("No parameters supplied")
@@ -399,7 +405,9 @@ class DataSet(BaseDataSet):
         self.set_interdependencies(interdeps, shapes)
         links = [Link(head=self.guid, **pdict) for pdict in parent_datasets]
         self.parent_dataset_links = links
-        self.mark_started(start_bg_writer=write_in_background)
+        self._perform_start_actions(
+            start_bg_writer=write_in_background, snapshot=snapshot_raw
+        )
 
     @property
     def cache(self) -> DataSetCacheWithDBBackend:
@@ -742,16 +750,27 @@ class DataSet(BaseDataSet):
         """
         if not self._started:
             self._perform_start_actions(start_bg_writer=start_bg_writer)
-            self._started = True
 
-    def _perform_start_actions(self, start_bg_writer: bool) -> None:
+    def _perform_start_actions(
+        self, start_bg_writer: bool, snapshot: str | None = None
+    ) -> None:
         """
         Perform the actions that must take place once the run has been started
         """
         paramspecs = new_to_old(self._rundescriber.interdeps).paramspecs
 
-        # Register all parameters in a single transaction (each add_parameter
-        # would otherwise commit on its own) to avoid one fsync per parameter.
+        writer_status = self._writer_status
+        write_in_background_status = writer_status.write_in_background
+        if (
+            write_in_background_status is not None
+            and write_in_background_status != start_bg_writer
+        ):
+            raise RuntimeError(
+                "All datasets written to the same database must "
+                "be written either in the background or in the "
+                "main thread. You cannot mix."
+            )
+
         with atomic(self.conn) as conn:
             for spec in paramspecs:
                 add_parameter(
@@ -764,32 +783,20 @@ class DataSet(BaseDataSet):
                     insert_into_results_table=False,
                 )
 
-        # Let the backend set up its storage (add columns to the main-database
-        # results table, create a per-dataset SQLite file, ...) now that all
-        # parameters are known.
-        self._results_backend.setup_on_start()
+            desc_str = serial.to_json_for_storage(self.description)
+            update_run_description(conn, self.run_id, desc_str)
 
-        desc_str = serial.to_json_for_storage(self.description)
+            set_run_timestamp(conn, self.run_id)
 
-        update_run_description(self.conn, self.run_id, desc_str)
+            pdl_str = links_to_str(self._parent_dataset_links)
+            update_parent_datasets(conn, self.run_id, pdl_str)
 
-        set_run_timestamp(self.conn, self.run_id)
+            if snapshot is not None:
+                self.add_snapshot(snapshot)
 
-        pdl_str = links_to_str(self._parent_dataset_links)
-        update_parent_datasets(self.conn, self.run_id, pdl_str)
-
-        writer_status = self._writer_status
+            # Backend setup changes the results storage, not the runs row.
+            self._results_backend.setup_on_start()
 
-        write_in_background_status = writer_status.write_in_background
-        if (
-            write_in_background_status is not None
-            and write_in_background_status != start_bg_writer
-        ):
-            raise RuntimeError(
-                "All datasets written to the same database must "
-                "be written either in the background or in the "
-                "main thread. You cannot mix."
-            )
         if start_bg_writer:
             writer_status.write_in_background = True
             if writer_status.bg_writer is None:
@@ -808,6 +815,7 @@ class DataSet(BaseDataSet):
         # results table exists in the per-dataset file), create any subscribers
         # that were requested while the dataset was still pristine.
         self._start_pending_subscribers()
+        self._started = True
 
     def mark_completed(self) -> None:
         """

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/instrument/instrument.py

@@ -169,6 +169,10 @@ class Instrument(InstrumentBase, metaclass=instrument_meta_class):
         if hasattr(self, "connection") and hasattr(self.connection, "close"):
             self.connection.close()
 
+        # Unregister the instrument before stripping it, so that a stripped
+        # and therefore unusable instrument is never left registered.
+        self.remove_instance(self)
+
         # check for the existense first since this may already
         # have been striped e.g. if the instrument has been closed once before
         if hasattr(self, "instrument_modules"):
@@ -181,7 +185,6 @@ class Instrument(InstrumentBase, metaclass=instrument_meta_class):
                     strip_attrs(channel, whitelist=["_short_name", "_parent"])
 
         strip_attrs(self, whitelist=["_short_name"])
-        self.remove_instance(self)
 
     @classmethod
     def close_all(
@@ -285,15 +288,34 @@ class Instrument(InstrumentBase, metaclass=instrument_meta_class):
             instance: The instance to remove
 
         """
+        if weakref.getweakrefcount(instance) == 0:
+            # Instances are only recorded through weak references, so there is
+            # nothing to remove. This is the case when the garbage collector
+            # finalizes the instance, since it clears all weak references to
+            # the instance before that. Leave the records alone then: before
+            # Python 3.14, weak containers postpone removing dead entries while
+            # being iterated over, but most of their methods apply postponed
+            # removals right away. That would make an iteration that the
+            # garbage collection interrupted fail with
+            # "RuntimeError: dictionary changed size during iteration".
+            return
+
         if instance in getattr(cls, "_instances", weakref.WeakSet()):
             cls._instances.remove(instance)
 
-        # remove from all_instruments too, but don't depend on the
-        # name to do it, in case name has changed or been deleted
+        # Look the instance up by name instead of iterating over all
+        # instruments, which a garbage collection could interrupt as described
+        # above. The identity check ensures that we never remove another
+        # instrument registered under the same name, e.g. when an instrument is
+        # closed again after its name has been reused.
+        try:
+            name = instance.name
+        except AttributeError:
+            # The instance was not initialized far enough to be registered.
+            return
         all_ins = cls._all_instruments
-        for name, ref in list(all_ins.items()):
-            if ref is instance:
-                del all_ins[name]
+        if all_ins.get(name) is instance:
+            del all_ins[name]
 
     @overload
     @classmethod

qcodes-0.63.0/src/qcodes/instrument/sims/Agilent_E8257D.yaml

@@ -0,0 +1,30 @@
+# SIMULATED INSTRUMENT FOR Agilent E8257D
+# Only covers what is needed to create the driver and switch the RF output.
+# The installed options are frequency option 520 (20 GHz) and the step
+# attenuator (1E1).
+spec: "1.0"
+devices:
+  device 1:
+    eom:
+      GPIB INSTR:
+        q: "\n"
+        r: "\n"
+    error: ERROR
+    dialogues:
+      - q: "*IDN?"
+        r: "Agilent Technologies, E8257D, US00000000, C.06.28"
+      - q: "DIAG:CPU:INFO:OPT:DET?"
+        r: "1E1,520,UNT"
+
+    properties:
+      output_enabled:
+        default: "0"
+        getter:
+          q: ":OUTP?"
+          r: "{}"
+        setter:
+          q: "OUTP {}"
+
+resources:
+  GPIB::1::INSTR:
+    device: device 1

qcodes-0.63.0/src/qcodes/instrument/sims/Agilent_E8267C.yaml

@@ -0,0 +1,41 @@
+spec: "1.0"
+devices:
+  device 1:
+    eom:
+      GPIB INSTR:
+        q: "\n"
+        r: "\n"
+    error: ERROR
+    dialogues:
+      - q: "*IDN?"
+        r: "Agilent Technologies, E8267C, US00000000, C.04.84"
+
+    properties:
+      power:
+        default: 0
+        getter:
+          q: "POW?"
+          r: "{}"
+        setter:
+          q: "POW {}"
+
+      power_offset:
+        default: 0
+        getter:
+          q: "POW:OFFS?"
+          r: "{}"
+        setter:
+          q: "POW:OFFS {}"
+
+      pulse_width:
+        # *RST value according to the E8257D/67D SCPI command reference
+        default: "+1.00000000E-006"
+        getter:
+          q: "PULM:INT:PWID?"
+          r: "{}"
+        setter:
+          q: "PULM:INT:PWID {}"
+
+resources:
+  GPIB::1::INSTR:
+    device: device 1

qcodes-0.63.0/src/qcodes/instrument/sims/Basel_SP983a.yaml

@@ -0,0 +1,35 @@
+spec: "1.0"
+devices:
+  device 1:
+    eom:
+      GPIB INSTR:
+        q: "\r\n"
+        r: "\r\n"
+    error: ERROR
+    dialogues:
+      - q: "GET O"
+        r: "Overload: OFF"
+
+    # replies follow the format that the driver parses
+    properties:
+      gain:
+        default: "1E8"
+        getter:
+          q: "GET G"
+          r: "Gain: {}"
+        setter:
+          q: "SET G {}"
+          r: "OK"
+
+      filter:
+        default: "1k"
+        getter:
+          q: "GET F"
+          r: "Filter: {}Hz"
+        setter:
+          q: "SET F {}"
+          r: "OK"
+
+resources:
+  GPIB::1::INSTR:
+    device: device 1

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/instrument/sims/Keithley_2450.yaml

@@ -67,6 +67,42 @@ devices:
         setter:
           q: "TRACe:CLEar"
 
+      sense_count:
+        default: 1
+        getter:
+          q: ":SENSe:COUNt?"
+          r: "{}"
+        setter:
+          q: ":SENSe:COUNt {}"
+        specs:
+          type: int
+
+      line_frequency:
+        default: "5.000000E+01"
+        getter:
+          q: ":SYSTem:LFRequency?"
+          r: "{}"
+
+      sense_current_nplc:
+        default: 1
+        getter:
+          q: ":SENSe:current:NPLCycles?"
+          r: "{}"
+        setter:
+          q: ":SENSe:current:NPLCycles {}"
+        specs:
+          type: float
+
+      source_current_delay:
+        default: 0
+        getter:
+          q: ":SOURce:current:DELay?"
+          r: "{}"
+        setter:
+          q: ":SOURce:current:DELay {}"
+        specs:
+          type: float
+
 resources:
   GPIB::1::INSTR:
     device: device wrong_mode

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/instrument/sims/Keithley_2600.yaml

@@ -203,3 +203,9 @@ resources:
 
   GPIB::2::INSTR:
     device: Keithley
+
+  GPIB::3::INSTR:
+    device: Keithley
+
+  GPIB::4::INSTR:
+    device: Keithley

qcodes-0.63.0/src/qcodes/instrument/sims/Keithley_6500.yaml

@@ -0,0 +1,50 @@
+spec: "1.0"
+devices:
+  device 1:
+    eom:
+      GPIB INSTR:
+        q: "\n"
+        r: "\n"
+    error: ERROR
+    dialogues:
+      - q: "*IDN?"
+        r: "KEITHLEY INSTRUMENTS,MODEL DMM6500,04000000,1.0.0"
+      - q: "*LANG?"
+        r: "SCPI"
+
+    properties:
+      data_format:
+        default: ASCII
+        getter:
+          q: "FORM:DATA?"
+          r: "{}"
+        setter:
+          q: "FORM:DATA {}"
+
+      display_digits:
+        default: 6
+        getter:
+          q: "DISP:VOLT:DC:DIG?"
+          r: "{}"
+        setter:
+          q: "DISP:VOLT:DC:DIG {}"
+        specs:
+          type: int
+          min: 4
+          max: 7
+
+      scan_count:
+        default: 1
+        getter:
+          q: "ROUT:SCAN:COUN:SCAN?"
+          r: "{}"
+        setter:
+          q: "ROUT:SCAN:COUN:SCAN {}"
+        specs:
+          type: int
+          min: 0
+          max: 100000000
+
+resources:
+  GPIB::1::INSTR:
+    device: device 1

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/instrument/sims/Keysight_E4980A.yaml

@@ -32,6 +32,23 @@ devices:
         setter:
           q: ":CURRent:LEVel {}"
 
+      impedance_range:
+        # preset value according to the E4980A/AL user's guide
+        default: "+1.00000E+02"
+        getter:
+          q: ":FUNCtion:IMPedance:RANGe?"
+          r: "{}"
+        setter:
+          q: ":FUNCtion:IMPedance:RANGe {}"
+
+      impedance_autorange:
+        default: 1
+        getter:
+          q: ":FUNCtion:IMPedance:RANGe:AUTO?"
+          r: "{}"
+        setter:
+          q: ":FUNCtion:IMPedance:RANGe:AUTO {}"
+
 resources:
   GPIB::1::INSTR:
     device: device 1

qcodes-0.63.0/src/qcodes/instrument/sims/Keysight_N5222B.yaml

@@ -0,0 +1,65 @@
+# SIMULATED INSTRUMENT FOR Keysight PNA N5222B
+# Only covers what is needed to create the driver and a few parameters.
+# The instrument has a single measurement "CH1_S11_1" (trace number 1).
+# Commands that are only written are modelled as properties with a setter
+# without a response, so that they do not leave a reply in the read buffer.
+spec: "1.0"
+devices:
+  N5222B:
+    eom:
+      GPIB INSTR:
+        q: "\n"
+        r: "\n"
+    error: ERROR
+    dialogues:
+      - q: "*IDN?"
+        r: "Keysight Technologies,N5222B,MY12345678,A.13.95.09"
+      - q: "*OPT?"
+        r: '""'
+      - q: "CALC:PAR:CAT:EXT?"
+        r: '"CH1_S11_1,S11"'
+
+    properties:
+
+      data_format:
+        default: "REAL,32"
+        setter:
+          q: "FORM {}"
+
+      byte_order:
+        default: "NORM"
+        setter:
+          q: "FORM:BORD {}"
+
+      selected_measurement_name:
+        default: "'CH1_S11_1'"
+        setter:
+          q: "CALC:PAR:SEL {}"
+
+      active_trace:
+        default: 1
+        getter:
+          q: "CALC:PAR:MNUM?"
+          r: "{}"
+        setter:
+          q: "CALC:PAR:MNUM {}"
+
+      averages:
+        default: 1
+        getter:
+          q: "SENS:AVER:COUN?"
+          r: "{}"
+        setter:
+          q: "SENS:AVER:COUN {}"
+
+      points:
+        default: 201
+        getter:
+          q: "SENS:SWE:POIN?"
+          r: "{}"
+        setter:
+          q: "SENS:SWE:POIN {}"
+
+resources:
+  GPIB::1::INSTR:
+    device: N5222B

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/instrument/sims/RTO_1000.yaml

@@ -25,7 +25,7 @@ devices:
           q: "TRIGger1:SOURce?"
           r: "{}"
         setter:
-          q: "TRIGger1:SOURce? {}"
+          q: "TRIGger1:SOURce {}"
 
       trigger level 1:
         default: 0
@@ -35,6 +35,14 @@ devices:
         setter:
           q: "TRIGger1:LEVel1 {}"
 
+      trigger mode:
+        default: AUTO
+        getter:
+          q: "TRIGger:MODE?"
+          r: "{}"
+        setter:
+          q: "TRIGger:MODE {}"
+
       channel range 1:
         default: 5
         getter:
@@ -49,6 +57,15 @@ devices:
         setter:
           q: "CHANnel1:OFFSet {}"
 
+      channel impedance 1:
+        # *RST value according to the R&S RTO user manual
+        default: 50
+        getter:
+          q: "CHANnel1:IMPedance?"
+          r: "{}"
+        setter:
+          q: "CHANnel1:IMPedance {}"
+
 resources:
   GPIB::1::INSTR:
     device: device 1

qcodes-0.63.0/src/qcodes/instrument/sims/Rigol_DG1062.yaml

@@ -0,0 +1,54 @@
+spec: "1.0"
+devices:
+  device 1:
+    eom:
+      GPIB INSTR:
+        q: "\n"
+        r: "\n"
+    error: ERROR
+    dialogues:
+      - q: "*IDN?"
+        r: "Rigol Technologies,DG1062Z,DG1ZA000000001,00.01.14"
+      - q: ":SOUR1:APPL?"
+        r: "\"SQU,1.000000E+03,5.000000E+00,0.000000E+00,0.000000E+00\""
+      - q: ":SOUR2:APPL?"
+        r: "\"SIN,1.000000E+03,5.000000E+00,0.000000E+00,0.000000E+00\""
+
+    # query responses use the scientific notation documented in the
+    # DG1000Z Programming Guide
+    properties:
+      burst_ncycles_1:
+        default: "1.000000E+00"
+        getter:
+          q: ":SOUR1:BURS:NCYC?"
+          r: "{}"
+        setter:
+          q: ":SOUR1:BURS:NCYC {}"
+
+      burst_phase_1:
+        default: "0.000000E+00"
+        getter:
+          q: ":SOUR1:BURS:PHAS?"
+          r: "{}"
+        setter:
+          q: ":SOUR1:BURS:PHAS {}"
+
+      burst_time_delay_1:
+        default: "0.000000E+00"
+        getter:
+          q: ":SOUR1:BURS:TDEL?"
+          r: "{}"
+        setter:
+          q: ":SOUR1:BURS:TDEL {}"
+
+      square_duty_cycle_1:
+        default: "5.000000E+01"
+        getter:
+          q: ":SOUR1:FUNC:SQU:DCYC?"
+          r: "{}"
+        setter:
+          q: ":SOUR1:FUNC:SQU:DCYC {}"
+
+resources:
+  GPIB::1::INSTR:
+    device: device 1

{qcodes-0.62.0 → qcodes-0.63.0}/src/qcodes/instrument/sims/Rigol_DS1074Z.yaml

@@ -46,6 +46,14 @@ devices:
           r: "{}"
         setter:
           q: ":TRIGger:MODE {}"
+      trigger_edge_level:
+        # response format from the MSO1000Z/DS1000Z Programming Guide
+        default: "1.600000e-01"
+        getter:
+          q: ":TRIGger:edge:LEVel?"
+          r: "{}"
+        setter:
+          q: ":TRIGger:edge:LEVel {}"
       data_source:
         default: "CHAN1"
         getter: