Qcodes

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

The April 2020 release of QCoDeS

Breaking Changes:
_________________

* The dictionary ``station.components['config']`` representing a Station
configuration loaded from a YAML file has been moved to ``station.config``.
The same change is reflected in the snapshot and the config can now
be accessed via ``station_snapshot['config']``. (1913)

* The ``QCoDeS`` configuration module has moved from ``qcodes.config`` to ``qcodes.configuration``
to disambiguate it from the current active config which is defined in ``qcodes.config`` as always (1682)

* It is now an error to overwrite get and set in a ``_BaseParameter`` subclass. Users have been warned against this
for a long time (1946)

* The legacy api such as Loop, active_loop, active_data_set, Measure, DataSet, new_data, load_data, Task, Wait, BreakIf,
FormatLocation, DataArray, Formatter, GNUPlotFormat, HDF5Format, DiskIO, are no more imported in ``QCoDeS`` namespace
by default. The core config now contains a new flag `import_legacy_api` that can be set to True if the legacy api
needs to be imported in the ``QCoDeS`` namespace. (1962)

* The Deprecated ``log_analysis`` module has been retired (1950)

Improved drivers:
_________________

* Types have been added to init functions of the concrete Keysight DMM drivers classes (1969)

Improved:
_________

* The public QCoDeS api imported from the toplevel qcodes namespace can also be imported from
their respective modules for ex ``qcodes.dataset``, ``qcodes.instrument`` etc. (1962)
* Complete types have been added to the qcodes station (1913)
* ``get_last_run`` has been improved to match the signature of ``get_runs`` (1960)
* The Snapshot of ``station.config`` (and other UserDicts) has been improved so that it can
be reloaded back into a dict (1961)

Documentation:
______________

* Improvements to several notebooks showing a better way of customizing parameters (1973)
* An option to execute Jupyter notebooks via Binder has been added (1943, 1948)
* A note that measurement context managers do not nest has been added (1949)
* A Typo in a Dynacool docstring has been corrected (1952)
* A note on limitations in delegate parameter has been added (1953)
* The attribute documentation for parameter has been improved (1956)
* B1500 documentation is included in the docs (1971)

Deprecations:
_____________

* ``get_data`` and ``get_values`` methods in dataset have been deprecated (1941)

Under the hood:
_______________

* Use pytest retry to re-execute known flaky test (1940)
* Update azure pipelines images (1938)
* Remove the debug log from data_set (1942)
* Code simplifications (1944)

Recommended dependencies:
_________________________

* Typechecking is performed with mypy 0.770 (1935)
* Documentation is build with latest sphinx patch release (2.4.4) (1954)
* Recommended version of h5py is 2.10 (1955, 1958)
* Hypothesis version installed for testing is limited to <5.6.0 (1959)
* Python version installed into conda env updated to 3.7.7 (1963)

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

This release contains a feature that was announced in 0.12.0 but not correctly included.

New Features:
_____________

New suite of sweep functions now in QCoDeS! The famous doNd functions
from the Copenhagen labs are now part of the QCoDeS library (1895).

The March 2020 release of QCoDeS

New Features:
_____________

* New suite of sweep functions now in QCoDeS! The famous `doNd` functions from the Copenhagen labs are now part of the QCoDeS library (1895).

Breaking Changes:
_________________

* The `DataSet.add_results` method no longer returns an `int`, but now returns `None`.


New Instrument drivers:
_______________________

* Keithley 3706A High Performance DMM/Switch System. (1884)
* QDevil QDAC High Precision Voltage Generator. (1613)


Improved drivers:
_________________

* Yokogawa GS200 no longer throws snapshot exception during initialization. (1930)
* Keysight 34465A DMM now returns ±`numpy.inf` for out-of-range values and not `9e±37`. (1929)

Improved:
_________

* The `DataSet` and `Measurement` classes now support out-of-thread data saving. Shave off up to 50% of your measurement time! (1896)


Documentation:
______________

No documentation updates in this release.


Deprecations:
_____________

The methods `set_measurement` and `measure` on the Station object have been deprecated.
They relied on the QCoDeS legacy dataset and were not frequently used. (1937)


Under the hood:
_______________

* The database version is now 9. An index was added for the `captured_run_id`. (1925)

Changelog for QCoDeS 0.12.0 *Prerelease*

The March 2020 release of QCoDeS *Prerelease*

Breaking Changes:
_________________

* The `DataSet.add_results` method no longer returns an `int`, but now returns `None`.


New Instrument drivers:
_______________________

* Keithley 3706A High Performance DMM/Switch System. (1884)
* QDevil QDAC High Precision Voltage Generator. (1613)


Improved drivers:
_________________

* Yokogawa GS200 no longer throws snapshot exception during initialization. (1930)
* Keysight 34465A DMM now returns ±`numpy.inf` for out-of-range values and not `9e±37`. (1929)

Improved:
_________

* The `DataSet` and `Measurement` classes now support out-of-thread data saving. Shave off up to 50% of your measurement time! (1896)


Documentation:
______________

No documentation updates in this release.


Deprecations:
_____________

Nothing deprecated :)


Under the hood:
_______________

* The database version is now 9. An index was added for the `captured_run_id`. (1925)

Changelog for QCoDeS 0.12.0 *Prerelease*

The March 2020 release of QCoDeS *Prerelease*

Breaking Changes:
_________________

* The `DataSet.add_results` method no longer returns an `int`, but now returns `None`.


New Instrument drivers:
_______________________

* Keithley 3706A High Performance DMM/Switch System. (1884)
* QDevil QDAC High Precision Voltage Generator. (1613)


Improved drivers:
_________________

* Yokogawa GS200 no longer throws snapshot exception during initialization. (1930)
* Keysight 34465A DMM now returns ±`numpy.inf` for out-of-range values and not `9e±37`. (1929)

Improved:
_________

* The `DataSet` and `Measurement` classes now support out-of-thread data saving. Shave off up to 50% of your measurement time! (1896)


Documentation:
______________

No documentation updates in this release.


Deprecations:
_____________

Nothing deprecated :)


Under the hood:
_______________

* The database version is now 9. An index was added for the `captured_run_id`. (1925)

New Instrument drivers:

* Keithley 7510 digital multimeter (1912)


Improved drivers:

* New features for Keithley 2450 (1906)
* Keysight B1500: Add units to current/voltage parameters to B1571A SMU module (1920)
* Keysight 344xx (1918)
* Yokogawa GS200 (1901)
* Agilent instruments' drivers (1904)
* Rohde Schwarz instruments' drivers (1911)

Improved:

* Allow passing database connection object to ``experiments()`` function (1894)


Documentation:

* Add notes to instrument driver example about Windows-specific drivers (1902)
* Fix links to issues in ``contributing.rst`` (1919)
* Remove unused imports in ``15_minutes_to_QCoDeS`` notebook (1923)


Deprecations:

* Deprecate ``DataSet.add_result`` as a duplicate of ``DataSet.add_results`` (1926)


Under the hood:

* Continuing improvements on typing:

* Fix type of timestamp in monitor (1922)
* Remove some doc types (1905)
* Complete typing of logging module (1907)
* Add types to monitor (1908)

* Avoid calling pip script (1910)
* Convert hypothesis args to kwargs (1916)


Recommended Dependencies:

* Build docs with sphinx 2.4.1 (1924)