QCoDeS 0.35.0 (2022-10-03)
NOTE: this release includes changes from QCoDeS 0.35.0b1 (2022-07-08), 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
instrument module, the
dond functions have been moved to the
and several methods removed from the public API of the
The new API is documented in the QCoDes API documentation 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 QCoDes API documentation 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
i.e. they use CamelCase as other classes and are named as
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.
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)
VisaInstrumentno longer calls
VisaInstrument.set_address()as part of its initialization. If you customize
VisaInstrument.set_address()in a subclass you may have to adapt that class. (#4397)
The deprecated method check_error has been removed from the visa instrument class. (#4426)
The unused attribute shared_kwargs on the
Instrumentclass has been removed. (#4427)
InstrumentChannelclasses 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.
DG1062Bursthas changed name to
DG1062Channelhas changed name to
DataSet.get_metadatamethod 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_metadatawould work and return the value stored under that tag. Note that this change brings consistency with how getting metadata via the
dataset.metadata['something']does return the value, and
dataset.metadata['SomeThinG']does not. (#4658)
ChannelListhas 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)
dondhas gained the ability to sweep multiple parameters at the same time enabling the creation of more complex measurements. (#4325)
Improve performance of
sqlite3converters and adapters used to write and read in the database.
Get rid of
sqlite3.Rowand irrelevant unpacking to
Settings of QCoDeS Validators are now available as properties (mostly read-only), e.g.
Numbersvalidator can now be accessed via
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)
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)
get_idnto AMI 430 3D virtual instrument driver so that it does not raise a warning when added to a station (#4610)
InstrumentBasehas a property
labelthat can host a human-readable label/title of the instrument. The label can be set in the __init__. (#4460)