Qcodes

==========================

Breaking Changes:
-----------------

- The deprecated and non functional function `qcodes.test()` has been removed. (6665)


Improved:
---------

- ``DelegateParameter`` now includes validators of its source Parameter into its validators. This ensures that a ``DelegateParameter``
with a non numeric source parameter is registered correctly in a measurement when the ``DelegateParameter`` it self does not
set a validator. (6585)
- Fix a regression introduced in 0.50.0 where a DelegateParameter initialized with a None source
would not correctly call get/set on the source parameter when this has been set. (6671)
- When passing ``bind_to_instrument=False`` to ``InstrumentBase.add_parameter`` a warning that
recommends not doing this is now raised suggesting a better alternative.
This replaces an existing inconsistent warning which was misleading. (6722)
- Only add magnet parameters if a magnet is detected in the Oxford Triton driver. (6792)


Improved Drivers:
-----------------

- Enabled use of ZNLE R&S VNA by recognizing the model name in RohdeSchwarzZNBBase, and creating an ZNLE class as an alias (6796)

==========================

Improved:
---------

- Fix a regression introduced in 0.50.0 where a DelegateParameter initialized with a None source
would not correctly call get/set on the source parameter when this has been set. 6671

==========================

Breaking Changes:
-----------------

- QCoDeS no longer attempts to automatically disable Sypders User module reloader (UMR).
The code was no longer working correctly with the latest version of Spyder and is not
maintainable since Spyder does not have a public api to disable UMR. If you use
QCoDeS from an editable install it is strongly recommended to disable UMR for QCoDeS.
See :ref:`gettingstarted` for more details. (6647)


Improved:
---------

- Improves the DataSetDefinition class to allow users to specify metadata to be added to the resulting dataset (6643)
- DelegateParameter now reads delegated properties from source rather than setting them at source change.
This resolves an issue when delegating from another delegate parameter may result in incorrect attributes. (6648)


New:
----

- Added a new feature to find links in a parameter chain by parameter type (6599)
- Added new methods to find instruments in a parameter chain by parameter type (6616)

==========================

Breaking Changes:
-----------------

- The methods `get`, `set`, `call` and `__getitem__` on the `InstrumentBase` class have been deprecated.
Parameters can be looked up by name using the `Instrument.parameters` dict and functions using `instrument.functions`
which is cleaner and fully equivalent. 6086
- The deprecated `qcodes.tests` module has been removed. Mock instruments can be found in `qcodes.instrument_drivers.mock_instruments` and
DriverTestCase as `qcodes.extensions.DriverTestCase`. 6480


Improved:
---------

- The deprecated support for enabling OpenCensus based telemetry has been removed.
QCoDeS will now warn if you try to enable OpenCensus based telemetry in the config.
Users are encouraged to roll out their own telemetry solution if they need it based
on OpenTelemetry. This also means that the `qcodes[opencensus]` install target has been removed.
The unused method `filter_out_telemetry_log_records` has been deprecated and will be removed in a future release. 6439
- Parameters registered in a qcodes Measurement are now snapshotted and stored in the resulting dataset under `dataset.snapshot["parameters"]` 6487
- Group parmeter now accepts a callable that returns a string command as its ``get_cmd``.
This is useful for the cases where the command string is dynamic; for example,
``lambda: f"CMD {get_id_that_specifies_the_command()} ?"``. 6520


Improved Drivers:
-----------------

- LakeShore335: Fix typo in setpoint_ramp parameter group 6430
- Add curve header parameters to Lakeshore model 336 that allows query of the input channel curve header.
This is useful to verify remotely if the correct temperature calibration curve is selected. 6520
- Fix Rigol DG4000 value mappings for ``output_polarity`` parameters. 6345

==========================

Improved:
---------

- Improve handling of corner cases where `Instrument.remove_parameter` could raise an exception. 6394
- `dond` now takes an optional `squeeze` flag as input. Inspired by Matplotlib's `plt.subplots` argument
of the same name, this allows the user to always get the same type returned from the function if set to False.
This makes it easier to write type checked code that uses `dond` as a function. 6422

===================

Breaking Changes:
-----------------

This release supports Python 3.10 and later.

Improved Drivers:
-----------------

- Fixed the Harvard DecaDAC range not including the highest bit. 6076
- Fixed Keysight 34465A DMM firmware version parsing. 6076
- Fixed Oxford Instruments Triton section parsing. 6076
- The long deprecated aliases to channels on MiniCircuits UsbSPDT drivers have been removed. This means that `channel_a` should be replaced by `a` and so on in any call to this driver. 6207
- Added power output parameters to LakeShore335 driver, allowing configuration of the maximum heater current. 6248
- Added input coupling and impedance parameters for channels in the Keysight Infiniium oscilloscope driver. 6293
- Added 'offset' parameter to Tektronix AWG Channels. 6303
- The ``qcodes.instrument_drivers.american_magnetics.AMIModel430`` driver can now be snapshotted with the heater missing or not enabled
without triggering warnings. Furthermore confusing aliases for parameters on the switch module have been deprecated since use of these would
lead to incorrect state of the parameters.
The aliases ``qcodes.instrument_drivers.american_magnetics.AMI_430_visa.AMI430_3D`` and ``qcodes.instrument_drivers.american_magnetics.AMI_430_visa.AMI430``
have been deprecated. 6306
- Add setpoint ramp rate parameters to LakeShore335 driver,
this allows to configure the setpoint ramp rate. 6322
- Add setpoint ramp status parameter to LakeShore335 driver,
this allows to monitor a ongoing setpoint ramp. 6322

Other Changes:
--------------

- Improved error handling when checking experiment IDs in the experiment list. 6305