6.5.9. qumada.utils.ramp_parameter

exception qumada.utils.ramp_parameter.Unsweepable_parameter[source]

Bases: Exception

qumada.utils.ramp_parameter.ramp_or_set_parameter(parameter, target, ramp_rate=0.1, ramp_time=10, setpoint_intervall=0.1, **kwargs)[source]

Trys to ramp parameter to specified value, if the parameter values are not float, they are just set.

qumada.utils.ramp_parameter.ramp_parameter(parameter, target, ramp_rate=None, ramp_time=None, setpoint_intervall=0.1, valid_units='all', **kwargs)[source]

Used for ramping float-valued parameters. Allows to specify ramp_rate and/or ramp_time. The ramp_time provides an upper limit to the time the sweep may take if specified.

Parameters:

  • parameter (QCoDeS parameter) – Parameter you want to sweep

  • target (float) – Target value.

  • ramp_rate (float | None, optional) – Specify ramp rate for the sweep. Is only relevant when ramp_time is None or ramping is finished before ramp_time has passed. If ramp is to slow, ramp_time will be used to define the ramp_speed.The default is None.

  • ramp_time (float | None, optional) – Maximum time the ramping may take. If ramp_rate is None, the sweep will be performed in ramp_time. Else, it provides an upper limit to the ramp time.

  • setpoint_intervall (float, optional) – Stepsize of the sweep. The smaller, the smoother the sweep will be Very small steps can increase the sweeptime significantly. The default is 0.1.

  • valid_units (str, optional) – Not used yet. The default is “all”.

  • **kwargs (TYPE) – DESCRIPTION.

Raises:

Unsweepable_parameter – Raised when the parameter has non-float values and cannot be swepted.

Returns:

True if sweep was completed, False if it failed.

Return type:

BOOL