Qcodes

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

Improved:
---------

- Corrected a bug where non integer step sizes were incorrectly rejected
from parameters without integer validators. (:pr:`5446`)

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

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

- The deprecated modules
`qcodes.data`, `qcodes.loop`, `qcodes.actions`, `qcodes.plots`,
`qcodes.measure`, `qcodes.extensions.slack`, `qcodes.utils.magic`, `qcodes.utils.qt_helpers`
`qcodes.utils.slack` has been removed.
The modules can be found in `qcodes_loop <https://github.com/qcodes/qcodes_loop>`_ (#5367)
- Update QCoDeS to work with the upcoming release of numpy 2.0.
The unused attributes `qcodes.utils.types.numpy_non_concrete_floats_instantiable` and
`qcodes.utils.types.numpy_non_concrete_complex_instantiable` have been removed from QCoDeS. (5399)
- The extra install targets qcodes[slack] and qcodes[qtplot] have been removed.
All dependencies on slack and pyqtgraph have moved to qcodes_loop. (5425)


New:
----

- QCoDeS now exports data that isn't measured on a grid to a XArray using `MultiIndex`.
Support for exporting these datasets to NetCDF has also been implemented.
See `this notebook <../examples/DataSet/Working-With-Pandas-and-XArray.ipynb>`__ for additional details. (5334)
- Add a register_name keyword to the ParameterBase constructor. If supplied, this value
will be used to register parameters in datasets instead of the default full_name.
Note that the MultiParameter and ArrayParameter classes do not currently support use
of the register_name. (5381)
- Large datasets are now exported to NetCDF4 using Dask delayed writer.
This avoids allocating a large amount of memory to process the whole dataset at the same time.
Size threshold at the moment is set to approximately 1 GB. (5391)
- The QCoDeS Parameters have now gained the ability to use multiple validators.
See `here <../examples/Parameters/Parameters.ipynb>`__ for examples of how to use this. (5426)

What's Changed
* remove deprecated scrict_concatenate flag from mypy by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5366
* Update traitlets requirement from ~=5.9.0 to ~=5.10.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5370
* remove deprecated loop moved to qcodes loop. by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5367
* Update matplotlib requirement from ~=3.7.0 to ~=3.8.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5371
* Update numpy requirement from ~=1.25.0 to ~=1.26.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5373
* Update typing-extensions requirement from ~=4.7.0 to ~=4.8.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5375
* Update portalocker requirement from ~=2.7.0 to ~=2.8.2 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5372
* Bump opencensus from 0.11.2 to 0.11.3 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5376
* Update zipp requirement from ~=3.16.2 to ~=3.17.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5377
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/QCoDeS/Qcodes/pull/5378
* Update hypothesis requirement from ~=6.84.0 to ~=6.86.2 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5382
* Stop using __file__ outside tests by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/4797
* Update hypothesis requirement from ~=6.86.2 to ~=6.87.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5383
* Remove deprecated compare_dictionaries by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5385
* Bump actions/checkout from 4.0.0 to 4.1.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5384
* Instrument tests: Avoid leaking state between tests by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5360
* Update google-api-core requirement from ~=2.11.0 to ~=2.12.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5386
* Export non gridded data to MultiIndex Xarray and compressed netcdf file by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5334
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/QCoDeS/Qcodes/pull/5387
* Update xarray requirement from ~=2023.8.0 to ~=2023.9.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5388
* Update CONTRIBUTING.rst by DCEM in https://github.com/QCoDeS/Qcodes/pull/5389
* Update index.rst (Add instructions about fetching tags) by DCEM in https://github.com/QCoDeS/Qcodes/pull/5390
* Fix pandas type check by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5398
* Update cffi requirement from ~=1.15.1 to ~=1.16.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5396
* Bump wcwidth from 0.2.6 to 0.2.7 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5397
* Bump cycler from 0.11.0 to 0.12.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5395
* Bump ruamel-yaml from 0.17.32 to 0.17.33 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5394
* Create Coord before passing it to xarray by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5392
* Bump wcwidth from 0.2.7 to 0.2.8 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5400
* Update ipython requirement from ~=8.15.0 to ~=8.16.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5401
* Bump packaging from 23.1 to 23.2 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5404
* Update fonttools requirement from ~=4.42.0 to ~=4.43.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5405
* Update charset-normalizer requirement from ~=3.2.0 to ~=3.3.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5406
* Rework config fixtures by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/4906
* Update executing requirement from ~=1.2.0 to ~=2.0.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5402
* Bump stack-data from 0.6.2 to 0.6.3 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5403
* remove non local CI job by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5407
* Update urllib3 requirement from ~=1.26.15 to ~=2.0.5 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5379
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/QCoDeS/Qcodes/pull/5409
* upgrade type stubs by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5410
* Remove main example by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5411
* Bump ruamel-yaml from 0.17.33 to 0.17.34 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5413
* Update babel requirement from ~=2.12.1 to ~=2.13.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5414
* Update traitlets requirement from ~=5.10.0 to ~=5.11.2 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5417
* Update nbconvert requirement from ~=7.8.0 to ~=7.9.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5415
* Bump ruamel-yaml-clib from 0.2.7 to 0.2.8 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5416
* Improve logger test by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5419
* Use Dask delayed to export large datasets to NetCDF by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5391
* Update quantify doc links by ereehuis in https://github.com/QCoDeS/Qcodes/pull/5421
* Bump ruamel-yaml from 0.17.34 to 0.17.35 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5424
* Update slack-sdk requirement from ~=3.22.0 to ~=3.23.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5423
* Update deepdiff requirement from ~=6.5.0 to ~=6.6.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5422
* remove slack and qtplot extra install targets by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5425
* Add register_name to register parameters by in datasets by samantha-ho in https://github.com/QCoDeS/Qcodes/pull/5381
* Bump cycler from 0.12.0 to 0.12.1 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5428
* Update bleach requirement from ~=6.0.0 to ~=6.1.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5429
* Update qcodes to support numpy 2.0 by peendebak in https://github.com/QCoDeS/Qcodes/pull/5399
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/QCoDeS/Qcodes/pull/5430
* Update h5py requirement from ~=3.9.0 to ~=3.10.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5431
* Update jupyter-core requirement from ~=5.3.0 to ~=5.4.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5432
* Update mypy requirement from ~=1.5.0 to ~=1.6.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5433
* Allow additional validators on parameter at runtime by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5426
* Update jupyter-client requirement from ~=8.3.0 to ~=8.4.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5434
* Update googleapis-common-protos requirement from ~=1.60.0 to ~=1.61.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5435
* Update hypothesis requirement from ~=6.87.0 to ~=6.88.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5437
* Update pillow requirement from ~=10.0.0 to ~=10.1.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5438
* Update pyqt5-sip requirement from ~=12.12.0 to ~=12.13.0 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5436
* Bump actions/checkout from 4.1.0 to 4.1.1 by dependabot in https://github.com/QCoDeS/Qcodes/pull/5439
* add changelog for 0.41.0 by jenshnielsen in https://github.com/QCoDeS/Qcodes/pull/5440

New Contributors
* DCEM made their first contribution in https://github.com/QCoDeS/Qcodes/pull/5389

**Full Changelog**: https://github.com/QCoDeS/Qcodes/compare/v0.40.0...v0.41.0

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

Improved:
---------

- The InstrumentLoggerAdapter has been updated to store the `instrument_name` and `instrument_type`
as fields on log records rather than the instrument it self. This enables opentelemetry to attache
the fields to a transmitted LogRecord for better filtering. (5297)
- In the QCoDeS DataSetProtocol newly created dataset now always have a captured_run_id / captured_counter
that matches the run_id / result_counter that they are assigned on creation. Previously these could be
out of sync if datasets measured elsewhere had been inserted into the database. (5329)
- The `pyvisa.ResourceManager` of a VISA instrument is now exposed
as `instr.resource_manager`. All VISA instruments will now use `weakref.finalize`
to close the visa resource on shutdown of the instrument. This should reduce the
chance that an instrument resource is not cleanup correctly on exit. (5341)


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

- Parameters controlling the pid-values, pumps and state of the temperature channels have been added to OxfordTriton.
This allows temperature sweeps from base temperature to several Kelvin to be fully automatic. Code to create such sweeps can be found at https://github.com/qdev-dk/MeasFunc/blob/main/measfunc/temperature_sweep.py. (#5316)


New:
----

- The QCoDeS Measurement Context manager, DataSaverBuilder and DoND functions have been instrumented as OpenTelemetry traces.
This enables users to correlate log messages with the the measurement that they were performed within.
See the `OpenTelemetry <https://opentelemetry.io/>`_ documentation for examples of how this can be used.

The log exporting using OpenCensus within QCoDeS is expected to be deprecated and eventually removed in line
with OpenCensus being discontinued. Users that are interested in gathering telemetry of their setups are encouraged
to provide their own solution based on OpenTelemetry. (5289)
- New features: datasaver_builder and dond_into are intermediate measurement extensions designed to fill a gap between
the low-level Measurement object and the high-level doNd functions. They allow convenient specification of parameter
dependencies for registration and doNd-like syntax while also allowing direct access to the underlying datasaver objects. (5294)

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

Improved:
---------

- Very noisy log messages from `azure.monitor.opentelemetry.exporter` are now
by default filtered and not shown in the console logger. This matches the
behavior of the OpenCensus exporter. 5278

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

Note that this will be the last version to support Python 3.8. Please upgrade to at least
python 3.9.

Improved:
---------

- The in memory cache of a dataset can now be configured both from the `qcodesrc.json` config file and when using `dond` to perform measurements.
The Exception raised when a `dond`, `do1d` etc. measurement is interrupted (`BreakConditionInterrupt`) has been made public as part of the
`qcodes.dataset` module so it can be intercepted and handled by the user. (5200)
- When writing a `DataSetInMem` back to a database the exp_id, counter and run_id are correctly updated
to reflect the sate of the new database. `write_metadata_to_db` has also been fixed to use
the database passed to init of the `DataSetInMem` class if no path is provided. (5209)


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

- Fix Keithley 3706A driver to use the updated interlock status strings
(following up on :pr:`5007`) (5147)
- Increase default timeout on R&S ZNB and allow the instrument to overwrite default timeout (5201)

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

Improved:
---------

- Fixed a typo in the readme preventing release to pypi (5132)