Qcodes

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

The August 2021 release of QCoDeS.

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

- `get_guids_from_multiple_run_ids` accepts connection over dbpath in the function. (3222)

----
New:
----
- Use thread pool when acquiring parameters to save time on recreating threads, new ThreadPoolParamsCaller,
use it in do1d, do2d, dond. (3170)
- QCoDeS has not the ability to set a default experiment in a Python session, and now, creating/ loading an experiment
automatically sets that experiment as the default one. (3214)
- The dond function has gained the ability to produce multiple datasets when measuring multiple parameters. (3186)
- Make parameter registration on instrument part of parameter init. (3191)
- Add post sweep actions to doND sweeps. (3283)
- load experiment functions accept duplicated experiment name, and new_experiment warns if creates duplicated
experiment. (3296)

---------
Improved:
---------

- Fix shapes of dond datasets with additional setpoints. (3305)

-----------------
Improved drivers:
-----------------

- Update voltage parameter for Keithley2600 SMU to be aware of measurement status. (3251)

---------------
Under the hood:
---------------

- Adding a Sphinx extension to document Parameter attributes. (3224)
- Work around legacy test issue with hf51.12.1 on conda forge. (3278)
- Make qcodes install mostly pep517/518 compliant. (3288)
- Log all installed packages. (3289)
- Remove pre-commit job from the repository in favor of pre-commit integration in the CI. (3293, 3290)
- Explicitly depend on setuptools. (3294)

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

The July 2021 release of QCoDeS.

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

- DelegateInstrument takes `parameters` as an optional, keyworded input argument. Any arguments passed as positional arguments after this one will break with this change. (3089)

----
New:
----

- A generalized N-dimensional ``dond`` function has been created to work with sweep objects and measurement parameters. Currently available sweep objects are ``LinSweep`` and ``LogSweep`` that can be used for `dond` measurements. (2990)
- The default value for `default_parameter_name` in the Loop QCoDeS dataset changed from ``amplitude`` to ``None``.
The ``amplitude`` value interferes with datasets where one of the setpoint arrays is called `amplitude`. (3095)
- Abstract parameters has been added which allow one to create abstract instrument types that have parameters which can be overwritten in a subclass allowing the creation of instruments
subclasses with a well-defined api. (3125, 3217, 3197)
- ``DataSetProtocol`` created to define the protocol that datasets must implement to be able to act as a storage device for the measurement class. (3075, 3092)
- Enable exporting complex numbers to netcdf. (3126)


---------
Improved:
---------

- DelegateInstrument can now support instrument channels. (3089)
- Decouple measurement name from dataset results table name to allow special characters in the measurement name. (3185)
- Update the get started document with installing and using spyder and jupyter. (3179)
- Add ``underlying_instrument`` property to ``_BaseParameter`` and use it in ``call_params_threaded`` instead of ``root_instrument``. (3127)
- Ensure that the per array metadata is also exported to dataarrays and not just datasets. (3116)
- Use threaded setting from config in doNd functions, and make ``process_params_meas`` public. (3096)
- Don't allow metadata tags that are not valid python identifiers (3192)
- Pulled out ``dataframe_to_csv`` into it's own submodule ``export_to_csv`` from the ``data_set`` submodule for easier reuse. (3061)


-----------------
Improved drivers:
-----------------

- Fix to Rohde & Schwarz ZNB driver for setting npts in CW mode. (3168)
- Update Keithley 2600 SMU current parameter to be aware of if current compliance is hit during measurement. (3160)
- Alazar ATS drivers: Fix buffer size for mode='TS' and buffers_per_acquisition > 1. (3118)
- New parameter ``complex_voltage`` has been added to the SR830 lockin amplifier. (3078)


---------------
Under the hood:
---------------

- Add logging to measurement runs in doNd functions (3206)
- Fix to speed up and properly set experiment in delegate device test (3199)
- Remove bare wait test due to random failures (3198)
- Revert checking of abstract parameters in post init due to unintended side effects (3197)
- Use public interface for instrument in parameters (3187)
- Fix numpy deprecation for ragged arrays (3184)
- Add documentation to explain automatic CI (3169)
- Give threads time to start in tests (3167)
- Minimum changes to allow type checking to pass with numpy 1.21 (3150)
- Add customDimensionsFilter to inject custom dim, and inject pythonExecutable (3143)
- Add export info metadata to dataset (3135)
- Pin typing packages the same way as other test dependancies do (3123)
- Do not preserve gh pages branch history significantly reducing the size of the full clone of the QCoDeS repository (3122)
- Add typing packages to conda CI (3115)
- Fix link to pyvisa intersphinx (3106)
- Compare shapes in ``RunDescriber`` equality method (3105)
- Fix invalid array syntax in json schema (3097)

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

The May 2021 release of QCoDeS.

----
New:
----

- DelegateInstrument and InstrumentGroup drivers (2928, 3031)
- Introducing merge_yaml function in Station and allow Station to load
multiple config yaml files (2936)
- Keysight VNA P9374A driver (3034)

---------
Improved:
---------

- Ensure that plot dataset uses axis in the expected order (3017)
- Make doNd reset original post_delay values + fix to keyboard interrupt (2996)
- [Bug fix] Return parameter data with same type as before applying scale or
offset (2980)
- Improved plotting of pre-shaped 2d data (3024)
- replace the use of Dict with Mapping for input args within instrument
module (3040)
- Convert input arguments to Mapping in dataset module (3051)
- use nan + i*nan as placeholder for complex numbers (3049)
- Add information about name keyword argument of Measurement module in
relevant docs (3052)

-----------------
Improved drivers:
-----------------

- Make wait times in blocking AMI430 field ramps adjustable (3032)
- Keithley 2600: 4 probe current sweep support (3023)

---------------
Under the hood:
---------------

- Add darker to precommit hooks (2979)
- tests: cleanup warning handling (2834)
- Fix NumpyJSONEncoder docstring (2994)
- remove scientific deps job (3014)
- upgrade precommit hooks to latest version (3037)

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

The April 2021 release of QCoDeS.

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

- `get_data_by_id` no longer returns data for standalone parameters if there are no dependent parameters in the dataset. For the same reason `plot_by_id` and `plot_dataset` will no longer plot these standalone parameters. (2918)
- `xarray` exported data no longer exports extra metadata columns under the `extra_metadata` tag since the extra dictionary level prevents exporting to `netcdf` (2934)

------------
Deprecation:
------------

- `get_data_by_id` and `get_shaped_data_by_runid` are now deprecated. These functions now all have better alternatives in the build in `get_parameter_data` as well as `Xarray` and `Pandas` exporters. (2921, 2925)

----
New:
----

- SP983c Basel IV amplifier remote control driver (2707)
- Add support for Keysight 34411A (2927)
- Added the functionality of getting guids from multiple run ids and directly from database (2930)
- NumpyJSONEncoder: Add support for the uncertanties' UFloat type (2933)
- Add conversion between qcodes legacy DataSet and xarray format (2938)

---------
Improved:
---------

- plot_dataset: Improved performance by using in memory cache when possible to avoid reloading data from disk (2918)
- contribution guidelines: remove no longer relevant sections and make the sections on naming somewhat less strict (2937)
- remove double assignment of dataset variable in example notebook of Performing-measurements-using-qcodes-parameters-and-dataset (2926)
- Update old driver notebooks (Agilent 34400A) docs (2377)
- Update link from NI VISA to Keysight IO Libraries Suite on 'Getting Started' Doc (2948)
- Removed ZI UHFLI notebook (2893)

-----------------
Improved drivers:
-----------------

- Significant performance improvement in Tektronix5014 driver (2910)
- AMI430 3D driver: allow instantiating from names of existing AMI430 instances, next to from AMI430 instances only driver (2949)
- AMI430 3D driver: add docstring, extra test for initializing from AMI430 by name driver (2951)
- Driver sr830 update: Add ChannelTrace class and related parameter ch{ch}_datatrace which makes buffered acquisition easier.(2894)

---------------
Under the hood:
---------------

- Log sample_name, exp_name, dataset name when Measurement starts (2952)
- Move private dataset export functions to their own module (2904)
- Remove wait time test (2935)
- fix(logger): Disable conditionally start logging for Sphinx documentation (2909)
- Name legacy test datasets (2950)
- use python -m pip to upgrade pip in github actions (2955)

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

The March 2021 release of QCoDeS.

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

- Because the mode of the Infiniium instrument driver is no longer set in the constructor, the change introduced by 2837 is a breaking change.

---------
Improved:
---------

- Support export to xarray for data with non unique indices (2848).
- Update use of Slack API in qcodes.utils.slack.Slack class (2813)
- Support dataset export to NetCDF or CSV after measurement ends (2782)
- Export more metadata to xarray dataset (2854)
- Extra explanation for Experiment and database in 15_minutes notebook (2838)

-----------------
Improved drivers:
-----------------

- Remove hardcoded acquire mode and allow users to set acquire mode for trace on Infiniium driver (2837)
- Updating SR830 driver with adding autorange method and its example notebook (2832)