v0.39.0

QCoDeS 0.39.0 (2023-06-20)

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)

QCoDeS 0.38.1

QCoDeS 0.38.1 (2023-04-26)

Improved:

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

QCoDeS 0.38.0

QCoDeS 0.38.0 (2023-04-25)

Breaking Changes:

• The modules qcodes_loop.data, qcodes_loop.plots, qcodes_loop.actions, qcodes_loop.loops,
  qcodes_loop.measure, qcodes_loop.extensions.slack and qcodes_loop.utils.magic,
  qcodes_loop.utils.qt_helpers have been split out into a separate package qcodes_loop.
  The respective modules in QCoDeS do still exist as deprecated aliases to the new modules in qcodes_loop
  but will be removed in a future release. To use the aliases QCoDeS must be installed with the loop extra e.g.
  you should install pip install qcodes[loop]. If you make use of these modules we recommend updating imports
  to use qcodes_loop as soon as possible. See the readme <https://github.com/qcodes/qcodes_loop>_ of
  qcodes_loop for more information.

  The functions qcodes.utils.helpers.tprint qcodes.utils.helpers.wait_secs and
  qcodes.utils.helpers.foreground_qt_window have been removed.
  These helper functions are only used in qcodes_loop and were moved there. (#4971)

• The default configuration of QCoDeS dataset GUID_components.GUID_type has changed from explicit_sample to random_sample.
  This means that QCoDeS GUIDs will no longer start with aaaaaaaa but with a random string. This significantly reduces the risk
  of duplicate GUIDs.
  This also means that that the ability to set a sample_id as part of the dataset GUID is disabled by default. With
  the default config its therefor an error to set GUID_components.sample to anything but the default value. The original
  behavior can be restored by setting GUID_components.GUID_type to explicit_sample in the config file but is not recommended.
  Users should make use of the sample_name attached to an experiment as an alternative. Note that if you have already created
  a local config you will need to update this for the changes to take effect. (#5031)

Improved:

• The helper functions guids_from_dbs, guids_from_dir, and guids_from_list_str have been added
  to the documented dataset api at qcodes.dataset. (#4989)

Improved Drivers:

• Fixed a bug in version parsing for Keysight 344XXA and Keysight E4980A which
  would result in incompatibility with packaging>21 under certain circumstances. (#5007)
• Fixed a bug in interlock status querying for Keithley 3706A. Originally, not all
  potential responses from the system were accounted for when querying for interlock
  status. A dictionary is used to map the response from the system to a string describing
  the interlock status. When the system returns a response that was not accounted for, this
  resulted in a KeyError being raised. Now, this dictionary accounts for all potential responses
  from the system. (#5013)
• Added support for AimTTi QL355TP power supply.
  Moved _numOutputChannels lookup table to the class body. (#5021)
• Increased range on setpoint property of Lakeshore Model 335,336,372 to support degree Celsius (#5043)
• Fix auto_sweep in Keysight PNA N52xx driver
  Fix units of polar sweeps in Keysight PNA N52xx driver (#5090)

New:

• The QCoDeS Station Instrument and InstrumentModule classes gained a method get_component
  which allows the user to get a component by name. Allowing the user to go from
  the full name of a component to the component itself. (#5028)

New Drivers:

• Add driver for Lakeshore Model 335 (#5043)

QCoDeS 0.37.0

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. #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. #4899

• DriverTestCase has been moved from qcodes.instrument_drivers.test to qcodes.tests.driver_test_case. #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. #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. #4932

• Remove deprecated Mercury iPS driver
  qcodes.instrument_drivers.oxford.mercuryiPS.MercuryiPS,
  use qcodes.instrument_drivers.oxford.OxfordMercuryiPS
  instead. #4936

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. #4857
• PyVISA 1.13 is now supported. #4895
• validate method of DelegateParameter now also validates the given value
  against the validator of the source parameter (if source parameter is present). #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. #4876
• Update the pyqtgraph plot backend for upstream changes in pyqtgraph. #4886
• QcoDeS is now typechecked with Pyright in addition to mypy. This should give a significantly
  better user experience when working in VS Code. #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 #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. #4840

Under the hood:

• Improve performance of parameter validator. #4887

v0.36.1

What's Changed

• Add changelog for 0.36.1 by @jenshnielsen in #4878
• make it a no op to mark a run completed twice by @jenshnielsen in #4876

Full Changelog: v0.36.0...v0.36.1

QCoDeS 0.36.0

QCoDeS 0.36.0 (2022-11-29)

Breaking Changes:

• The test_intrument and test_intruments functions are no longer available
  from the toplevel qcodes namespace.
  If you require these functions they must be imported from
  qcodes.instrument_drivers.test. (#461`)
• The deprecated imports of Loop, Measure and members of qcodes.data in the toplevel QCoDeS namespace has been
  removed. (#4674)
• Explicitly setting a sample id in the qcodesrc.json config file has been deprecated. This feature is
  expected to be very lightly used. Please do get in touch if you rely on it. This will eventually
  be replaced by a random string. For the same reason load_by_run_spec will no longer print
  sample_id as part of the output when more than one potential match is found.
  Note that this is different from the sample_name set as part of an experiment which is still supported. (#4763)

Improved:

• The sweeps used by doNd has gained the ability to perform a get call after setting the parameter and storing
  that value in the dataset rather than the value set. (#4759)
• plot_dataset will now correctly wrap long titles into multiple lines. (#4770)
• Keithley calibration: adjust calibration date before saving new calibration (#4779)
• Visa insturments have gained the pyvisa_sim_file argument. This allows easier instantiation of
  simulated visainstrments in tests (both in QCoDeS and external) as well as use of simulated instruments in
  station yaml files. (#4790)
• dond functions now return the dataset after KeyboardInterrupt or BreakConditionInterrupt.
  Instead of raising the interrupts, they are now logged as warning. (#4801)
• The function qcodes.dataset.load_from_netcdf now always perservers order of the dependent coordinates
  when loading a netcdf file into memory. (#4802)
• Add rundescriber_from_json to dataset public API
  for materializing RunDescriber objects from json strings (#4811)
• Add RunDescriber, InterDependencies_, ParamSpecTree to dataset public API (#4816)
• All public methods avilable in qcodes.dataset that takes a
  path to a db or data file now accepts a pathlib.Path object in addition to a str. (#4818)

New:

• Add a callback to dataset.get_parameter_data.
  This is usefull to track the progress of the data download.
  Since sqlite3 does not allow to keep track of the data loading progress,
  we compute how many sqlite requests correspond to a certain percentage of
  progress which is dictated by a config parameter "callback_percent".
  Then we perform x sql request instead of one, running the callback everytime. (#4688)

QCoDeS 0.35.2

QCoDeS 0.35.2 (2022-10-05)

This is a bugfix to fix an issue where the qcodes.utils.helpers module had an unexpected dependency
on pytest.

QCoDeS 0.35.0

QCoDeS 0.35.0 (2022-10-03)

NOTE: this release includes changes from :doc:0.35.0b1,
refer to that changelog for details of those changes.

In this release a large refactoring of the QCoDeS modules organization has taken place.
Among other changes the instrument module has been split into a parameters and
instrument module, the dond functions have been moved to the dataset module
and several methods removed from the public API of the utils module.

The new API is documented in the :ref:api section of the QCoDeS homepage.

Going forward we aim to establish a policy where the QCoDeS public API is defined
by modules explicitly documented in the :ref:api and importable from submodules at most
one level deep. I.e. from qcodes.instrument import InstrumentChannel is supported but
f`rom qcodes.instrument.channel import InstrumentChannel is considered unsupported.

Importing from previously existing locations should continue to work
but it is recommended to update to the new API.
In the future we may deprecate and eventually remove these modules
but no firm date is set for this.

Please report any issues you may see with importing from the previously existing API
or if you depend on any functions, classes etc. not available from the new public API.

This release also includes a significant but still incomplete refactoring of the QCoDeS
instrument drivers in qcodes.instrument_drivers. Many but not all drivers have been updated
to use names that conform to the standard documented
here <../examples/writing_drivers/Creating-Instrument-Drivers.ipynb#Naming-the-Instrument-class>__
i.e. they use CamelCase as other classes and are named as InstrumentvendorModel
and are importable directly from the instrument vendor module i.e.
from qcodes.instrument_drivers.AimTTi import AimTTiPL068P .
Older names for the classes are still importable from their original places unless explicitly
documented otherwise. In the future we may deprecate and eventually remove the instrument driver classes whos names don't conform to the standard,
but no firm date is set for this.

Breaking Changes:

• The standard metadata as defined by pep621 has moved from setup.cfg
  to pyproject.toml. This should have no user facing consequences unless
  you install qcodes from source using a very old version of pip (<19)
  or use unusual pip configurations. (#4382#)

• :class:VisaInstrument no longer calls :meth:VisaInstrument.set_address as part of its
  initialization. If you customize :meth:VisaInstrument.set_address in a subclass you may have
  to adapt that class. (:pr:4397)

• The deprecated method check_error has been removed from the visa instrument class. (#4426)

• The unused attribute shared_kwargs on the Instrument class has been removed. (#4427)

• The following InstrumentChannel classes have changed name for consistency.
  This is expected to be a change with few user facing implications unless you are explicitly
  subclassing the mentioned classes.

  • DG1062Burst has changed name to RigolDG1062Burst
  • DG1062Channel has changed name to RigolDG1062Channel (#4538)

• DataSet.get_metadata method for retrieving a metadata value for a
  given tag is now case-sensitive with respect to the tag.
  For example, if metadata was added with dataset.add_metadata('something', 1),
  it can only be retrieved by using its exact casing of the tag,
  dataset.get_metadata('something'), and not e.g.
  dataset.get_metadata('SomeThinG'). In the previous versions of QCoDeS,
  any casing of the tag in DataSet.get_metadata would work and return the
  value stored under that tag. Note that this change brings consistency
  with how getting metadata via the dataset.metadata works:
  dataset.metadata['something'] does return the value, and
  dataset.metadata['SomeThinG'] does not. (#4658)

Improved:

• ChannelTuple and ChannelList has gained the ability to call methods defined on the channels
  in the sequence in a way similar to how QCoDeS Functions can be called. (#4292)

• dond has gained the ability to sweep multiple parameters at the same time enabling the creation of more complex
  measurements. (#4325)

• Improve performance of sqlite3 converters and adapters used to write and read in the database.

  Get rid of sqlite3.Row and irrelevant unpacking to list. (#4446)

• Settings of QCoDeS Validators are now available as properties (mostly read-only),
  e.g. min_value and max_value of the Numbers validator can now be accessed
  via numbers_validator_instance.min_value and numbers_validator_instance.max_value (#4602)

• Fixed a bug in the QCoDeS JSON encoder that would trigger an infinite recursion for snapshots containing
  bytes (bytestrings with a b prefix). (#4621)

• InstrumentBase and ParameterBase now call snapshot() on _meta_attrs attributes that inherit from Metadatable. (#4655)

• The Dataset no longer prints upgrade progressbars when upgrading an empty database. This means that
  the progressbar will no longer be shown when creating a new database. (#4969)

Improved Drivers:

• A parameter auto_freq_ref was added to the Keysight.N51x1 class.
  From the Keysight manual:
  This command enables or disables the ability of the signal generator to
  automatically select between the internal and an external reference oscillator.

  In addition, the val_mapping dictionary of the rf_output parameter is now using the create_on_off_val_mapping function. (#4472)

• Add get_idn to AMI 430 3D virtual instrument driver so that it does not raise a warning when added to a station (#4610)

New:

• :class:InstrumentBase has a property label that can host
  a human-readable label/title of the instrument.
  The label can be set in the init. (#4460)

QCoDeS 0.35.0b1

QCoDeS 0.35.0b1 (2022-07-08)

This is a beta release of the upcoming QCoDeS 0.35.0 release.

In this release a large refactoring of the QCoDeS modules organization has taken place.
Among other changes the instrument module has been split into a parameters and
instrument module, the dond functions have been moved to the dataset module
and several methods removed from the public API of the utils module.

The new API is documented in the :ref:api section of the QCoDeS homepage.

Going forward we aim to establish a policy where the QCoDeS public API is defined
by modules explicitly documented in the :ref:api and importable from submodules at most
one level deep. I.e. from qcodes.instrument import InstrumentChannel is supported but
from qcodes.instrument.channel import InstrumentChannel is considered unsupported.

Importing from previously existing locations should continue to work
but it is recommended to update to the new API.
In the future we may deprecate and eventually remove these modules
but no firm date is set for this.

Please report any issues you may see with importing from the previously existing API
or if you depend on any functions, classes etc. not available from the new public API.

Breaking Changes:

• Removed deprecated units property from DataArray. (#4358)
• Removed deprecated qcodes.version module. Use qcodes.__version__ (#4307)

Improved:

• :func:qcodes.dataset.doNd now logs more information about how parameters are
  unpacked and grouped making it easier to debug. (#4288)
• do_nd: save plot with 'tight' bbox to prevent tick marks with long labels
  pusing out the axis label out of the canvas window and not visible (#4360)
• Significant refactor of internal modules and public API (#4357, #4355,
  #4353, #4351, #4350, #4349, #4348, #4334, #4330,
  #4326, #4316, #4309, #4307, #4306, #4300, #4294,
  #4286, #4283, #4275, #4274, #4272, #4266, #4237,
  #4224, #3972, #4265, #3536)
• Fixed bug in fallback code for Sphinx extension breaking documentation of certain attributes (#4223)

New Drivers:

• Add Keithley 2634B model to 2600 driver (#4290)

Improved Drivers:

• The Keysight N52 series drivers have gained a parameter to control RF output. (#4301)
• Improved Keysight N51x1 driver: make frequency option detection compatible with multiple options installed on device. (#4342)

0.34.1 - June 2022 (2022-06-14)

QCoDeS 0.34.1 (2022-06-14)

Breaking Changes:

• Restrictions on instrument names are now less strict than in 0.34.0. Submodules are allowed
  to have names that are not valid identifier as long as the full name is an valid identifier. (#4257)