diff --git a/docs/device_object.rst b/docs/device_object.rst index 2269222..d5d5cc0 100644 --- a/docs/device_object.rst +++ b/docs/device_object.rst @@ -143,7 +143,7 @@ in the function call of measurement scripts, you can set the argument priorize_s Another important feature is the possibility to save and load device working points. To store a certain configuration as your default working point, use device.save_defaults. This stores all parameter values (of parameters that can be set). With device.set_defaults() you can reset it to the stored configuration. Alternatively you can use "device.save_state(name)" and "device.set_state(name)" to store and set multiple working points with -custom names. They can also be accessed via "device.states" in case you forgot the name. +custom names. They can also be accessed via "device.states" in case you forgot the name. For all of those methods the parameters are ramped to the final state by default (with the default QuMada ramp rate). You can use the argument "ramp = False" to avoid this, or use keyword arguments (ramp_rate, duration) to adjust the ramp speed when calling the methods. Alternatively, you can set the parameter "device.ramp" to True or False in order to control the behaviour for the complete device. diff --git a/src/qumada/measurement/device_object.py b/src/qumada/measurement/device_object.py index f5dcaed..e62f77b 100644 --- a/src/qumada/measurement/device_object.py +++ b/src/qumada/measurement/device_object.py @@ -83,7 +83,7 @@ def update_terminal_parameters(self): for param in mapping.keys(): self.terminals[terminal].update_terminal_parameter(param) - def save_defaults(self, ramp = None, **kwargs): + def save_defaults(self, ramp=None, **kwargs): """ Saves current values as default for all Terminals and their parameters """ @@ -97,20 +97,20 @@ def save_state(self, name: str): """ self.states[name] = self.save_to_dict(priorize_stored_value=False) - def set_state(self, name: str, ramp = None, **kwargs): + def set_state(self, name: str, ramp=None, **kwargs): if ramp is None: ramp = self.ramp self.load_from_dict(self.states[name]) - self.set_stored_values(ramp = ramp, **kwargs) + self.set_stored_values(ramp=ramp, **kwargs) - def set_stored_values(self, ramp = None, **kwargs): + def set_stored_values(self, ramp=None, **kwargs): if ramp is None: ramp = self.ramp for terminal in self.terminals.values(): for param in terminal.terminal_parameters.values(): param.set_stored_value() - def set_defaults(self, ramp = None, **kwargs): + def set_defaults(self, ramp=None, **kwargs): """ Sets all Terminals and their parameters to their default values """ @@ -118,7 +118,7 @@ def set_defaults(self, ramp = None, **kwargs): ramp = self.ramp for terminal in self.terminals.values(): for param in terminal.terminal_parameters.values(): - param.set_default(ramp = ramp, **kwargs) + param.set_default(ramp=ramp, **kwargs) def voltages(self): """ @@ -686,7 +686,7 @@ def save_default(self): logger.warning(f"{e} was raised when trying to save default value of {self.name}") pass - def set_default(self, ramp = True, **kwargs): + def set_default(self, ramp=True, **kwargs): """ Sets value to default value """ @@ -701,7 +701,7 @@ def set_default(self, ramp = True, **kwargs): else: logger.warning(f"No default value set for parameter {self.name}") - def set_stored_value(self, ramp = True, **kwargs): + def set_stored_value(self, ramp=True, **kwargs): """ Sets value to stored value from dict """ @@ -716,7 +716,7 @@ def set_stored_value(self, ramp = True, **kwargs): else: logger.warning(f"No stored value set for parameter {self.name}") - def __call__(self, value=None, ramp = None): + def __call__(self, value=None, ramp=None): if value is None: return self.value else: diff --git a/src/qumada/utils/ramp_parameter.py b/src/qumada/utils/ramp_parameter.py index 0a0f5f7..ff939ee 100644 --- a/src/qumada/utils/ramp_parameter.py +++ b/src/qumada/utils/ramp_parameter.py @@ -24,7 +24,6 @@ import logging import time - from math import isclose from qumada.utils.generate_sweeps import generate_sweep @@ -73,7 +72,7 @@ def ramp_parameter( Not used yet. The default is "all". tolerance: float, optional If abs(current_value- target_value) < tolerance*max(current_value, target_value) - no ramp is done. Default 1e-5. + no ramp is done. Default 1e-5. **kwargs : TYPE DESCRIPTION. @@ -99,7 +98,7 @@ def ramp_parameter( if isinstance(current_value, float): LOG.debug(f"target: {target}") - if isclose(current_value, target, rel_tol = tolerance): + if isclose(current_value, target, rel_tol=tolerance): LOG.debug("Target value is sufficiently close to current_value, no need to ramp") return True