QCoDeS 0.54.0 (2025-10-01)¶
Breaking Changes:¶
Removal of deprecated code
Removed modules:
Removed the deprecated
qcodes.instrument_drivers.american_magnetics.AMI430
module. UseAMIModel4303D
fromqcodes.instrument_drivers.american_magnetics
instead.Removed the deprecated
qcodes.utils.spyder_utils
module containing theadd_to_spyder_UMR_excludelist
function. This utility was known to not work with latest Spyder versions and was unused in QCoDeS.
Removed classes:
Removed the deprecated
AMI430_3D
andAMI430
classes fromqcodes.instrument_drivers.american_magnetics.AMI430
. UseAMIModel4303D
andAMIModel430
fromqcodes.instrument_drivers.american_magnetics
instead.Removed deprecated methods from
AMI430SwitchHeater
Removed deprecated
AMI430_VISA
class fromip_to_visa.py
.Removed the deprecated
ConnectionPlus
class fromqcodes.dataset.sqlite.connection
. UseAtomicConnection
class instead.Removed the deprecated
AlazarTech_ATS
class. UseAlazarTechATS
instead.Removed the deprecated
WaveformGenerator_33XXX
class. UseKeysight33xxx
instead.Removed the following deprecated Keysight classes: -
Keysight_34410A
, useKeysight34410A
instead -Keysight_34411A
, useKeysight34411A
instead -Keysight_34460A
, useKeysight34460A
instead -Keysight_34461A
, useKeysight344xxA
instead -Keysight_34465A
, useKeysight34465A
instead -Keysight_34470A
, useKeysight34470A
instead -N51x1
, useKeysightN51x1
instead -PNABase
, useKeysightPNABase
instead -PNAxBase
, useKeysightPNAxBase
instead -KeysightSubModule
, useKeysight34980ASwitchMatrixSubModule
instead -KeysightSwitchMatrixSubModule
, useKeysight34980ASwitchMatrixSubModule
instead -B1500Module
, useKeysightB1500Module
instead -_Keysight_344xxA
, useKeysight344xxA
insteadRemoved the deprecated Keysight submodules: -
Trigger
, useKeysight344xxATrigger
instead -Sample
, useKeysight344xxASample
instead -Display
, useKeysight344xxADisplay
insteadRemoved the deprecated MiniCircuits classes: -
SwitchChannelBase
, useMiniCircuitsSPDTSwitchChannelBase
instead -SPDT_Base
, useMiniCircuitsSPDTBase
insteadRemoved the deprecated
USBHIDMixin
class
Removed functions:
Removed from
qcodes.utils.deprecate
: -deprecation_message
-issue_deprecation_warning
-deprecate
decorator (usetyping_extensions.deprecated
instead) -_catch_deprecation_warnings
-assert_not_deprecated
-assert_deprecated
Removed
make_connection_plus_from
function fromqcodes.dataset.sqlite.connection
(#7122)
The following modules have been deprecated in this release and will be removed in a future version:
qcodes.instrument.delegate.grouped_parameter
qcodes.instrument.function
qcodes.instrument.group_parameter
qcodes.instrument.specialized_parameters
qcodes.instrument.sweep_values
qcodes.instrument.base
qcodes.instrument.parameter
qcodes.utils.command
qcodes.utils.dataset
qcodes.utils.installation
qcodes.utils.helpers
qcodes.utils.metadata
qcodes.utils.plotting
qcodes.utils.threading
qcodes.utils.validators
Please consult the API documentation at QCoDes API documentation for alternatives and migration paths. (#7262)
The methods
InstrumentBase.__getitem__
,InstrumentBase.get
,InstrumentBase.set
,InstrumentBase.call
are now deprecated with a PendingDeprecationWarning rather than a QCoDeSDeprecationWarning. This better reflects the state where there is no plan to remove them but usage is discouraged. The PendingDeprecationWarning is not printed to console by default. (#7318)Registration and Unpacking interfaces created in ParameterBse
ParameterBase
now implements new depends_on`,is_controlled_by
, andhas_control_of``properties that allow subclasses to define ``InterDependencies_
relationships directlyParameterBase.unpack_self
allows subclasses to unpack themselves duringDataSaver.add_result
, which removes the requirement for users to add pre-definedInterDependencies_
results explicitlyMeasurement.register_parameter
has been refactored to follow the relationship links defined in parameter subclasses and automatically register related parameters with the appropriate relationshipsDataSaver.add_result
has been refactored to take advantage of the newunpack_self
methodBreaking Changes - A dependent parameter registered with an independent parameter as its
setpoints
no longer requires that the independent parameter be registered first, if the independent parameter is ParameterBase subclass and not a str - Previously, a ParameterWithSetpoints whose setpoints values were explicitly added in add_result would use the explicit version. Now, an error is raised if the explicit values are not within some tolerance of the internal values (as with other duplication). -DataSaver.add_result
signature has changed from*res_tuple
to*result_tuples
(#7346)The method
to_xarray_dataarray_dict
on the classesDataSet
andDataSetInMem
have been deprecated and replaced byto_xarray_dataset_dict
. This new method allows export of datasets that still only contain one measured parameter but can contain related coordinates such as these given by an inferred relationship. (#7432)ChannelTuple/ChannelList.get_channel_by_name
support for getting more than one channel has been deprecated. To get more than one channel useget_channels_by_name
.get_channels_by_name
is guaranteed to always return an instance of the class it was called on independently of the number of channels supplied. In the futureget_channel_by_name
will be updated to ensure that it always returns a single channel. The Exception raised when no argument is given toget_channel_by_name
has changed fromException
toTypeError
in line with how functions behave when an argument is missing. (#7486)
Improved:¶
Add a read-only option to sqlite connection (#4783)
Fix
load_from_netcdf
failing for non-completed datasets due to missingcompleted_timestamp_raw
orrun_timestamp_raw
attribute. (#7221)The QCoDeS dataset now correctly captures data for inferred parameters when added via
datasaver.add_result
. Previously these were discarded due to an oversight. Any parameters added in this way are available viaDataSetProtocol.get_parameter_data
but not exported to xarray or pandas. Future improvements to these parameters are planned and tracked here.The property
InterDependencies_.non_dependencies
has been deprecated and replaced byInterDependencies_.top_level_parameters
that correctly includes inferred parameters. TheInterDependencies_
object has gained two additional methodsfind_all_parameters_in_tree
andall_parameters_in_tree_by_group
.The not documented but publicly importable functions
qcodes.dataset.exporters.export_to_pandas.load_to_concatenated_dataframe
andqcodes.dataset.exporters.export_to_pandas.load_to_dataframe_dict
now require an extra argument in the form of anInterDependencies_
object. Users are discouraged from using anything not documented in the QCoDeS API documentation outside QCoDeS. (#7240)Fix NetCDF export for datasets with None timestamp_raw values by using sentinel values (-1) during export and converting them back to None on import. This ensures NetCDF compatibility while preserving the original None values through round-trip export/import operations. (#7333)
When exporting Datasets to xarray where the shape is known, either by the use of utilities such as dond or manually specified, inferred parameters related to the setpoints and measured parameters are now included in the XArray Dataset. (#7432)
Exporting datasets to XArray no longer warns if two or more variables are exported with different setpoint names and/or values. No functionality of the export has changed. If the setpoints for different measured parameters have the same name, missing values will be replaced by NaN such that the measured parameters have the same coordinates in XArray. If different setpoint names are used, the exporter will automatically handle merging coordinates so each data variable is assigned its own coordinates. (#7442)
Fixed a bug where omitting data for one or more variables could result in an inconsistent dataset cache. Missing data is now filled with appropriate empty values (0, “” or NaN depending on the data type) (#7502)
ChannelList
andAutoLoadableChannelList
can now correctly infer the type of channels in the list when indexed using__get_item
e.g.mychannellist[0]
For consistency with the base classes the parent type inAutoLoadableChannelList
has changed fromInstrument
toInstrumentBase
which may require downstream changes for type checking to work correctly. (#7520)
Improved Drivers:¶
Added operation mode in the SGS100A instrument to be able to change between NORMal and BBBYpass operation modes. Defaults to NORMal. (#7344)
Corrected power range for Keysight P5004B (#7360)
Changes to Cryomagnetics 4G Driver
Added missing initialization of self._RETRY_WRITE_ASK and self._RETRY_TIME in the write_raw method to handle communication retries on VisaIOError.
Updated set_field to correctly recognize Standby as a valid final state when setting the magnetic field to 0 T.
Modified wait_while_ramping to check the actual magnetic field value via self._get_field() instead of relying on the status byte, since the instrument may stay in the Ramping state even after reaching the target field.
Fixed unit parsing to handle unexpected trailing characters in the instrument’s response. (e.g., “r”).
Fixed get_parser for Vmag, Iout, and Vout to remove units and return float.
Added timeout condition to wait_while_ramping to prevent infinite loop. Will trigger Exception if timeout occurs.
Fixed conversion calculations in _set_rate and _get_rate.
Added function get_rates to return rates for all ranges in Tesla/min as a dictionary.
Modified _set_rate to update all ranges (0-4) on the instrument (picks min value between set rate and maximum current limit for each range)
Add small sleep (0.1 seconds) between write calls during max_current_limit initialization.
Fixed/added unit tests to accurately reflect code changes.
Modified set_field() to allow users to control the strictness of wait_while_ramping() timeout condition (1e-4 was too precise and was triggering false timeouts). (#7405)
Keysight 33xxx drivers now have statically assigned channels. This improves documentation and makes it possible for type checkers and IDEs to detect class member variables without instantiating the driver. (#7521)
New:¶
Added
qcodes.dataset.export_datasets_and_create_metadata_db()
function to export all datasets from a database to NetCDF files and create a new metadata-only database. This enables users to maintain lightweight databases for metadata while relying on NetCDF files for data analysis, significantly reducing storage requirements for large experimental datasets. (#7212)
New Drivers:¶
Under the hood:¶
Refactors the InterDependencies_ class to simplify reasoning about and query of the ParamSpecBase relationships by embedding them in a NetworkX Directional Graph (DiGraph)
Resolves #7079 (#7256)
In dond, only process get_after_set in the loop instances where the parameter is actually being set (#7307)
DataSetProtocol.to_xarray_dataset
andDataSetProtocol.to_xarray_dataarray_dict
now avoids creating a Pandas MultiIndex to infer the correct dataset shape if the shape is already known. This will resolve issues where datasets are exported with incorrect array shapes due to round off errors in the setpoints (coordinates). (#7413)