From 39ba6cb8742d62df74d64671eaef2fc372691218 Mon Sep 17 00:00:00 2001 From: "Jens H. Nielsen" Date: Thu, 26 Jan 2023 08:01:35 +0100 Subject: [PATCH 1/2] Generate changelog for 0.37 --- docs/changes/0.37.0.rst | 55 +++++++++++++++++++ docs/changes/index.rst | 1 + .../newsfragments/4623.improved_driver | 1 - .../newsfragments/4840.improved_driver | 7 --- docs/changes/newsfragments/4870.improved | 2 - docs/changes/newsfragments/4876.improved | 2 - docs/changes/newsfragments/4886.improved | 1 - docs/changes/newsfragments/4887.underthehood | 1 - docs/changes/newsfragments/4894.breaking | 5 -- docs/changes/newsfragments/4899.breaking | 3 - docs/changes/newsfragments/4922.breaking | 1 - docs/changes/newsfragments/4923.breaking | 3 - docs/changes/newsfragments/4932.breaking | 2 - docs/changes/newsfragments/4936.breaking | 4 -- docs/changes/newsfragments/4938.improved | 2 - 15 files changed, 56 insertions(+), 34 deletions(-) create mode 100644 docs/changes/0.37.0.rst delete mode 100644 docs/changes/newsfragments/4623.improved_driver delete mode 100644 docs/changes/newsfragments/4840.improved_driver delete mode 100644 docs/changes/newsfragments/4870.improved delete mode 100644 docs/changes/newsfragments/4876.improved delete mode 100644 docs/changes/newsfragments/4886.improved delete mode 100644 docs/changes/newsfragments/4887.underthehood delete mode 100644 docs/changes/newsfragments/4894.breaking delete mode 100644 docs/changes/newsfragments/4899.breaking delete mode 100644 docs/changes/newsfragments/4922.breaking delete mode 100644 docs/changes/newsfragments/4923.breaking delete mode 100644 docs/changes/newsfragments/4932.breaking delete mode 100644 docs/changes/newsfragments/4936.breaking delete mode 100644 docs/changes/newsfragments/4938.improved diff --git a/docs/changes/0.37.0.rst b/docs/changes/0.37.0.rst new file mode 100644 index 00000000000..d8a816de9d1 --- /dev/null +++ b/docs/changes/0.37.0.rst @@ -0,0 +1,55 @@ +QCoDeS 0.37.0 (2023-01-26) +========================== + +Breaking Changes: +----------------- + +- ``InstrumentBase.ancestors`` now returns a tuple of ancestors + to the current Instrument, InstrumentChannel or InstrumentModule and not a list. + + ``dond ``, ``do1d`` etc. now returns tuples of Matplotlib axes and colorbars + when plotting and not lists. (:pr:`4894`) +- Datasets are now exported to a folder next to the database by default rather then to the users home folder. + Note that if you had specifically configured this in a local config file this should be updated too for the + change to take effect. (:pr:`4899`) +- DriverTestCase has been moved from `qcodes.instrument_drivers.test` to `qcodes.tests.driver_test_case`. (:pr:`4922`) +- `qcodes.instrument_drivers.VoltageDivider` and `qcodes.instrument_drivers.devices.VoltageDivider` has + been deprecated. Its functionality is better implemented in `qcodes.parameters.DelegateParameter` which + is also significantly better tested and more general. (:pr:`4923`) +- The QDevil QDAC 1 driver has been migrated to qcodes_contrib_drivers and is included from version + 0.18.0. The driver in QCoDeS is deprecated and will be removed in a future release. (:pr:`4932`) +- Remove deprecated Mercury iPS driver + ``qcodes.instrument_drivers.oxford.mercuryiPS.MercuryiPS``, + use ``qcodes.instrument_drivers.oxford.OxfordMercuryiPS`` + instead. (:pr:`4936`) + + +Improved: +--------- + +- ``validate`` method of ``DelegateParameter`` now also validates the given value + against the validator of the source parameter (if source parameter is present). (:pr:`4870`) +- The dataset logic has been updated to ensure that if you set an already completed + dataset as completed the completion timestamp will not be updated. (:pr:`4876`) +- Update the pyqtgraph plot backend for upstream changes in pyqtgraph. (:pr:`4886`) +- QcoDeS is now typechecked with Pyright in addition to mypy. This should give a significantly + better user experience when working in VS Code. (:pr:`4938`) + + +Improved Drivers: +----------------- + +- The Minicircuits USB SPDT driver now supports running with the more modern version of the driver DLL `mcl_RF_Switch_Controller_NET45.dll` (:pr:`4623`) +- Two parameters are added to the `Keysight.N51x1` class, conditioned on it having the 'UNW' option: + 1. Having the pulse modulation status on or off. + 2. Setting it to 'internal' or 'external'. + + From the Keysight manual: + 1. This command enables or disables pulse modulation for the selected path. + 2. This command sets the source of the pulse modulation. (:pr:`4840`) + + +Under the hood: +--------------- + +- Improve performance of parameter validator. (:pr:`4887`) diff --git a/docs/changes/index.rst b/docs/changes/index.rst index b33576417c5..90ae3139a3d 100644 --- a/docs/changes/index.rst +++ b/docs/changes/index.rst @@ -3,6 +3,7 @@ Changelogs .. toctree:: Unreleased + 0.37.0 <0.37.0> 0.36.1 <0.36.1> 0.36.0 <0.36.0> 0.35.2 <0.35.2> diff --git a/docs/changes/newsfragments/4623.improved_driver b/docs/changes/newsfragments/4623.improved_driver deleted file mode 100644 index 1f4fc44a0e0..00000000000 --- a/docs/changes/newsfragments/4623.improved_driver +++ /dev/null @@ -1 +0,0 @@ -The Minicircuits USB SPDT driver now supports running with the more modern version of the driver DLL `mcl_RF_Switch_Controller_NET45.dll` diff --git a/docs/changes/newsfragments/4840.improved_driver b/docs/changes/newsfragments/4840.improved_driver deleted file mode 100644 index a81bb854529..00000000000 --- a/docs/changes/newsfragments/4840.improved_driver +++ /dev/null @@ -1,7 +0,0 @@ -Two parameters are added to the `Keysight.N51x1` class, conditioned on it having the 'UNW' option: - 1. Having the pulse modulation status on or off. - 2. Setting it to 'internal' or 'external'. - -From the Keysight manual: - 1. This command enables or disables pulse modulation for the selected path. - 2. This command sets the source of the pulse modulation. diff --git a/docs/changes/newsfragments/4870.improved b/docs/changes/newsfragments/4870.improved deleted file mode 100644 index dd5f7e87864..00000000000 --- a/docs/changes/newsfragments/4870.improved +++ /dev/null @@ -1,2 +0,0 @@ -``validate`` method of ``DelegateParameter`` now also validates the given value -against the validator of the source parameter (if source parameter is present). diff --git a/docs/changes/newsfragments/4876.improved b/docs/changes/newsfragments/4876.improved deleted file mode 100644 index 6cc0738a705..00000000000 --- a/docs/changes/newsfragments/4876.improved +++ /dev/null @@ -1,2 +0,0 @@ -The dataset logic has been updated to ensure that if you set an already completed -dataset as completed the completion timestamp will not be updated. diff --git a/docs/changes/newsfragments/4886.improved b/docs/changes/newsfragments/4886.improved deleted file mode 100644 index a1d650f6ebc..00000000000 --- a/docs/changes/newsfragments/4886.improved +++ /dev/null @@ -1 +0,0 @@ -Update the pyqtgraph plot backend for upstream changes in pyqtgraph. diff --git a/docs/changes/newsfragments/4887.underthehood b/docs/changes/newsfragments/4887.underthehood deleted file mode 100644 index 7cbe8307ba6..00000000000 --- a/docs/changes/newsfragments/4887.underthehood +++ /dev/null @@ -1 +0,0 @@ -Improve performance of parameter validator. diff --git a/docs/changes/newsfragments/4894.breaking b/docs/changes/newsfragments/4894.breaking deleted file mode 100644 index aae0f983237..00000000000 --- a/docs/changes/newsfragments/4894.breaking +++ /dev/null @@ -1,5 +0,0 @@ -``InstrumentBase.ancestors`` now returns a tuple of ancestors -to the current Instrument, InstrumentChannel or InstrumentModule and not a list. - -``dond ``, ``do1d`` etc. now returns tuples of Matplotlib axes and colorbars -when plotting and not lists. diff --git a/docs/changes/newsfragments/4899.breaking b/docs/changes/newsfragments/4899.breaking deleted file mode 100644 index 9d897ecb8e1..00000000000 --- a/docs/changes/newsfragments/4899.breaking +++ /dev/null @@ -1,3 +0,0 @@ -Datasets are now exported to a folder next to the database by default rather then to the users home folder. -Note that if you had specifically configured this in a local config file this should be updated too for the -change to take effect. diff --git a/docs/changes/newsfragments/4922.breaking b/docs/changes/newsfragments/4922.breaking deleted file mode 100644 index 290e07772ee..00000000000 --- a/docs/changes/newsfragments/4922.breaking +++ /dev/null @@ -1 +0,0 @@ -DriverTestCase has been moved from `qcodes.instrument_drivers.test` to `qcodes.tests.driver_test_case`. diff --git a/docs/changes/newsfragments/4923.breaking b/docs/changes/newsfragments/4923.breaking deleted file mode 100644 index 069f63a8bc4..00000000000 --- a/docs/changes/newsfragments/4923.breaking +++ /dev/null @@ -1,3 +0,0 @@ -`qcodes.instrument_drivers.VoltageDivider` and `qcodes.instrument_drivers.devices.VoltageDivider` has -been deprecated. Its functionality is better implemented in `qcodes.parameters.DelegateParameter` which -is also significantly better tested and more general. diff --git a/docs/changes/newsfragments/4932.breaking b/docs/changes/newsfragments/4932.breaking deleted file mode 100644 index 63d0aec194a..00000000000 --- a/docs/changes/newsfragments/4932.breaking +++ /dev/null @@ -1,2 +0,0 @@ -The QDevil QDAC 1 driver has been migrated to qcodes_contrib_drivers and is included from version -0.18.0. The driver in QCoDeS is deprecated and will be removed in a future release. diff --git a/docs/changes/newsfragments/4936.breaking b/docs/changes/newsfragments/4936.breaking deleted file mode 100644 index 818b792db8f..00000000000 --- a/docs/changes/newsfragments/4936.breaking +++ /dev/null @@ -1,4 +0,0 @@ -Remove deprecated Mercury iPS driver -``qcodes.instrument_drivers.oxford.mercuryiPS.MercuryiPS``, -use ``qcodes.instrument_drivers.oxford.OxfordMercuryiPS`` -instead. diff --git a/docs/changes/newsfragments/4938.improved b/docs/changes/newsfragments/4938.improved deleted file mode 100644 index 475f45d57e5..00000000000 --- a/docs/changes/newsfragments/4938.improved +++ /dev/null @@ -1,2 +0,0 @@ -QcoDeS is now typechecked with Pyright in addition to mypy. This should give a significantly -better user experience when working in VS Code. From 7384576ba70f2e749d58547155ad71967077d0aa Mon Sep 17 00:00:00 2001 From: "Jens H. Nielsen" Date: Thu, 26 Jan 2023 08:18:35 +0100 Subject: [PATCH 2/2] add missing items manually --- docs/changes/0.37.0.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/changes/0.37.0.rst b/docs/changes/0.37.0.rst index d8a816de9d1..3af15558e4c 100644 --- a/docs/changes/0.37.0.rst +++ b/docs/changes/0.37.0.rst @@ -27,6 +27,10 @@ Breaking Changes: Improved: --------- +- When a dataset is exported an optional user supplied entry point is called. See + `here <../examples/DataSet/Exporting-data-to-other-file-formats.html#Automatically-post-process-exported-datasets.>`__ + for more details. (:pr:`4857`) +- PyVISA ``1.13`` is now supported. (:pr:`4895`) - ``validate`` method of ``DelegateParameter`` now also validates the given value against the validator of the source parameter (if source parameter is present). (:pr:`4870`) - The dataset logic has been updated to ensure that if you set an already completed