From c489da44d0103526b7febb60f706d41109e54b73 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 3 Jan 2025 13:44:21 +0000 Subject: [PATCH] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/device_object.rst | 12 ++++++------ docs/examples.rst | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/device_object.rst b/docs/device_object.rst index 1da0e2b..9f2f2be 100644 --- a/docs/device_object.rst +++ b/docs/device_object.rst @@ -178,10 +178,10 @@ Buffered Measurements You can use the device_object to run buffered measurements in an even more comfortable way then with the measurement_script based approach. It is possible to store all relevant buffer settings in the device_object. The measurements will then use the stored settings by default unless you explicetly specify -different ones. +different ones. The settings are identical to the ones discussed in :ref:`BufferedMeasurements`. -Create the buffer_settings dictionary and simply set +Create the buffer_settings dictionary and simply set .. code:: python @@ -217,9 +217,9 @@ To run a buffered measurement, simply set the "buffered" kwarg to True when runn For most scripts that can be started from the device level, QuMada automatically uses the buffered version of the script if you set "buffered" to True. -If you use the arbitrary "device.run_measurement()" you obviously have to specify a buffered script yourself. Keep in mind that not all measurement scripts support buffered measurements. +If you use the arbitrary "device.run_measurement()" you obviously have to specify a buffered script yourself. Keep in mind that not all measurement scripts support buffered measurements. It is always possible to override the settings stored in the device object by explicitely passing the buffer_settings and buffer_script_setup dictioniaries as corresponding arguments -when runing a measurement. +when runing a measurement. As it is quite common to frequently adjust the number of points recorded during a measurement, the number of points specified in the buffer_settings is overridden in case a number of points or a setpoint array is specified when running a measurement. QuMada will provide a warning if this happens. For example: @@ -234,7 +234,7 @@ For example: "delay": 0, } device.buffer_settings = buffer_settings - + device.gate1.voltage.measured_ramp(0.5, buffered = True, num_points = 200) will record a measurement with 200 datapoints. This works only if "num_points" and either "duration" or "sampling_rate" are specified in the buffer settings. @@ -249,7 +249,7 @@ Sensor Compensation Sensor compensation with the device_object works in the same way as explained in :ref:`SensorCompensation'. Simply set the type of the compensating gates to "compensating" (or "comp") and specify the required attributes. This can be done either by directly addressing them via "device.terminal.parameter.attribute_name" (recommended) or by altering the parameter dictionary and updating the device object -as described in :ref:`UpdatingDevice`. Again, sensor compensation works only for a few measurement types. +as described in :ref:`UpdatingDevice`. Again, sensor compensation works only for a few measurement types. ################## Safety features (WIP) diff --git a/docs/examples.rst b/docs/examples.rst index e4c54c3..458d6a7 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -418,7 +418,7 @@ trigger_mode [str]: continuous, edge, tracking_edge, pulse, tracking_pulse, digital. Note that some of those modes may not be available for some instruments. Furthermore, the trigger mode is changed automatically by the buffer class in some cases after the trigger input is assigned. For example using the trigger inputs of the MFLI - requires the digital trigger mode. Note that Qumada might automatically change the trigger_mode in case the chosen trigger input (cf. trigger mapping) is not compatible. This is for example the case for the MFLI's dedicated trigger inputs, which only support digital trigger mode. + requires the digital trigger mode. Note that Qumada might automatically change the trigger_mode in case the chosen trigger input (cf. trigger mapping) is not compatible. This is for example the case for the MFLI's dedicated trigger inputs, which only support digital trigger mode. trigger_mode_polarity [str]: positive,