Skip to content

[wip] Refactor do2d #7066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jenshnielsen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[wip] Refactor do2d #7066

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
200 changes: 30 additions & 170 deletions src/qcodes/dataset/dond/do_2d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,24 @@
from __future__ import annotations

import logging
import sys
import time
from typing import TYPE_CHECKING, cast

import numpy as np
from opentelemetry import trace
from tqdm.auto import tqdm

from qcodes import config
from qcodes.dataset.descriptions.detect_shapes import detect_shape_of_measurement
from qcodes.dataset.dond.do_nd_utils import (
BreakConditionInterrupt,
_handle_plotting,
_register_actions,
_register_parameters,
_set_write_period,
catch_interrupts,
)
from qcodes.dataset.measurements import Measurement
from qcodes.dataset.threading import (
SequentialParamsCaller,
ThreadPoolParamsCaller,
process_params_meas,
)
from qcodes.parameters import ParameterBase

LOG = logging.getLogger(__name__)
TRACER = trace.get_tracer(__name__)

from .do_nd import DondKWargs, dond
from .sweeps import LinSweep

if TYPE_CHECKING:
from collections.abc import Sequence
from typing_extensions import Unpack

from qcodes.dataset.descriptions.versioning.rundescribertypes import Shapes
from qcodes.dataset.dond.do_nd_utils import (
ActionsT,
AxesTupleListWithDataSet,
BreakConditionT,
ParamMeasT,
)
from qcodes.dataset.experiment_container import Experiment
from qcodes.parameters import ParameterBase

LOG = logging.getLogger(__name__)
TRACER = trace.get_tracer(__name__)


@TRACER.start_as_current_span("qcodes.dataset.do2d")
Expand All @@ -57,21 +34,7 @@ def do2d(
num_points2: int,
delay2: float,
*param_meas: ParamMeasT,
set_before_sweep: bool | None = True,
Copy link
Collaborator Author

@jenshnielsen jenshnielsen Apr 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

flush_columns and set_before_sweep are not supported by dond yet. Need to figure out how to deal with that

enter_actions: ActionsT = (),
exit_actions: ActionsT = (),
before_inner_actions: ActionsT = (),
after_inner_actions: ActionsT = (),
Copy link
Collaborator Author

@jenshnielsen jenshnielsen Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are also not available.

Copy link
Contributor

@jpdehollain jpdehollain Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enter_actions and exit_actions are available in dond.
Here's a suggestion to include before_inner_actions and after_inner_actions:

  1. Add arguments pre_sweep_actions and post_sweep_actions to LinSweep
  2. In _Sweeper.__getitem__, check if index is first or last in the sweep, then append pre_sweep or post_sweep to the actions accordingly.

Happy to have a go at this in a separate PR if you think it's a good solution

write_period: float | None = None,
measurement_name: str = "",
exp: Experiment | None = None,
flush_columns: bool = False,
do_plot: bool | None = None,
use_threads: bool | None = None,
additional_setpoints: Sequence[ParameterBase] = tuple(),
show_progress: bool | None = None,
log_info: str | None = None,
break_condition: BreakConditionT | None = None,
**kwargs: Unpack[DondKWargs],
Copy link

Copilot AI May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The function docstring has not been updated to reflect the new keyword arguments that are forwarded to dond; consider updating it to clearly document the accepted parameters.

Copilot uses AI. Check for mistakes.
) -> AxesTupleListWithDataSet:
"""
Perform a 1D scan of ``param_set1`` from ``start1`` to ``stop1`` in
Expand All @@ -93,134 +56,31 @@ def do2d(
will be called at each step. The function should take no arguments.
The parameters and functions are called in the order they are
supplied.
set_before_sweep: if True the outer parameter is set to its first value
before the inner parameter is swept to its next value.
enter_actions: A list of functions taking no arguments that will be
called before the measurements start
exit_actions: A list of functions taking no arguments that will be
called after the measurements ends
before_inner_actions: Actions executed before each run of the inner loop
after_inner_actions: Actions executed after each run of the inner loop
write_period: The time after which the data is actually written to the
database.
measurement_name: Name of the measurement. This will be passed down to
the dataset produced by the measurement. If not given, a default
value of 'results' is used for the dataset.
exp: The experiment to use for this measurement.
flush_columns: The data is written after a column is finished
independent of the passed time and write period.
additional_setpoints: A list of setpoint parameters to be registered in
the measurement but not scanned.
do_plot: should png and pdf versions of the images be saved after the
run. If None the setting will be read from ``qcodesrc.json``
use_threads: If True measurements from each instrument will be done on
separate threads. If you are measuring from several instruments
this may give a significant speedup.
show_progress: should a progress bar be displayed during the
measurement. If None the setting will be read from ``qcodesrc.json``
log_info: Message that is logged during the measurement. If None a default
message is used.
break_condition: Callable that takes no arguments. If returned True,
measurement is interrupted.
**kwargs: kwargs are the same as for dond and forwarded directly to dond.
Copy link
Collaborator Author

@jenshnielsen jenshnielsen Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add links like do0d/do1d


Returns:
The QCoDeS dataset.

"""

if do_plot is None:
do_plot = cast("bool", config.dataset.dond_plot)
if show_progress is None:
show_progress = config.dataset.dond_show_progress

meas = Measurement(name=measurement_name, exp=exp)
if log_info is not None:
meas._extra_log_info = log_info
else:
meas._extra_log_info = "Using 'qcodes.dataset.do2d'"
Copy link
Collaborator Author

@jenshnielsen jenshnielsen Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Retain this log message like do1d/do0d

all_setpoint_params = (
param_set1,
param_set2,
*tuple(s for s in additional_setpoints),
)

measured_parameters = tuple(
param for param in param_meas if isinstance(param, ParameterBase)
)

try:
loop_shape = (num_points1, num_points2, *tuple(1 for _ in additional_setpoints))
shapes: Shapes | None = detect_shape_of_measurement(
measured_parameters, loop_shape
)
except TypeError:
LOG.exception(
f"Could not detect shape of {measured_parameters} "
f"falling back to unknown shape."
)
shapes = None

_register_parameters(meas, all_setpoint_params)
_register_parameters(meas, param_meas, setpoints=all_setpoint_params, shapes=shapes)
_set_write_period(meas, write_period)
_register_actions(meas, enter_actions, exit_actions)

if use_threads is None:
use_threads = config.dataset.use_threads

param_meas_caller = (
ThreadPoolParamsCaller(*param_meas)
if use_threads
else SequentialParamsCaller(*param_meas)
return cast(
"AxesTupleListWithDataSet",
dond(
LinSweep(
param=param_set1,
start=start1,
stop=stop1,
delay=delay1,
num_points=num_points1,
),
LinSweep(
param=param_set2,
start=start2,
stop=stop2,
delay=delay2,
num_points=num_points2,
),
*param_meas,
**kwargs,
squeeze=True,
),
)

with (
catch_interrupts() as interrupted,
meas.run() as datasaver,
param_meas_caller as call_param_meas,
):
dataset = datasaver.dataset
additional_setpoints_data = process_params_meas(additional_setpoints)
setpoints1 = np.linspace(start1, stop1, num_points1)
for set_point1 in tqdm(setpoints1, disable=not show_progress):
if set_before_sweep:
param_set2.set(start2)

param_set1.set(set_point1)

for action in before_inner_actions:
action()

time.sleep(delay1)

setpoints2 = np.linspace(start2, stop2, num_points2)

# flush to prevent unflushed print's to visually interrupt tqdm bar
# updates
sys.stdout.flush()
sys.stderr.flush()
for set_point2 in tqdm(setpoints2, disable=not show_progress, leave=False):
# skip first inner set point if `set_before_sweep`
if set_point2 == start2 and set_before_sweep:
pass
else:
param_set2.set(set_point2)
time.sleep(delay2)

datasaver.add_result(
(param_set1, set_point1),
(param_set2, set_point2),
*call_param_meas(),
*additional_setpoints_data,
)

if callable(break_condition):
if break_condition():
raise BreakConditionInterrupt("Break condition was met.")

for action in after_inner_actions:
action()
if flush_columns:
datasaver.flush_data_to_database()

return _handle_plotting(dataset, do_plot, interrupted())
Loading