Coherence Flux #954

Jacfomg · 2024-07-30T14:12:31Z

Using #949 as it is does not allow me to create several path during the for loop for the bias an have all the report separate. They will be overwritten as far as I understand. Can you take a look @alecandido or @andrea-pasquale

Checklist:

Reviewers confirm new code works as expected.
Tests are passing.
Coverage does not decrease.
Documentation is updated.
Compatibility with Qibo modules (Please edit this section if the current pull request is not compatible with the following branches).
- Qibo: master
- Qibolab: main
- Qibolab_platforms_qrc: main

To be more explicit as an example and template

codecov · 2024-07-30T14:21:01Z

Codecov Report

Attention: Patch coverage is 45.45455% with 6 lines in your changes missing coverage. Please review.

Project coverage is 97.46%. Comparing base (9828b46) to head (142255d).
Report is 200 commits behind head on main.

Files with missing lines	Patch %	Lines
src/qibocal/auto/execute.py	45.45%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #954      +/-   ##
==========================================
- Coverage   97.55%   97.46%   -0.10%     
==========================================
  Files         118      118              
  Lines        9056     9067      +11     
==========================================
+ Hits         8835     8837       +2     
- Misses        221      230       +9

Flag	Coverage Δ
unittests	`97.46% <45.45%> (-0.10%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/qibocal/auto/execute.py	`93.49% <45.45%> (-4.72%)`	⬇️

... and 1 file with indirect coverage changes

andrea-pasquale

Thanks @Jacfomg for sharing this!
You can find a few suggestions down below.

runcards/coherence_flux.py

andrea-pasquale · 2024-07-30T14:27:30Z

runcards/coherence_flux.py

+@dataclass
+class CoherenceFluxSignalData(Data):
+    """Coherence acquisition outputs."""
+
+    data: dict[QubitId, npt.NDArray] = field(default_factory=dict)
+    """Raw data acquired."""


I would just define a dictionary instead of defining a dataclass.

I agree it would do the job but I like keeping similarities between protocols and sacripts it makes things simpler IMO

My vote goes for skipping the 1-parameter class (there is not even any method associated, so it is truly a wrapper, not even used for the type...)

andrea-pasquale · 2024-07-30T14:29:19Z

runcards/coherence_flux.py

+
+        # D2
+        params_qubit = {
+            "w_max": 5.552552628640306 * 1e9,  # FIXME: this is not the qubit frequency


True, but at the same time what we usually have in the runcard is the maximum frequency, right?

What we usually have in the runcard is something wrong then 🤷‍♂️

runcards/coherence_flux.py

andrea-pasquale · 2024-07-30T14:35:06Z

Using #949 as it is does not allow me to create several path during the for loop for the bias an have all the report separate.

I think that the correct of way of using it would be for you to define an executor for each flux point.
Something like:

for bias in biases:
    with Executor.open(
    "myexec",
    path="test_rx_calibration",
    platform="dummy",
    targets=[target],
    update=True,
    force=True,
) as e:
    ....

Would this work for you?

Jacfomg · 2024-07-30T14:37:54Z

Using #949 as it is does not allow me to create several path during the for loop for the bias an have all the report separate.

I think that the correct of way of using it would be for you to define an executor for each flux point. Something like:
for bias in biases:
    with Executor.open(
    "myexec",
    path="test_rx_calibration",
    platform="dummy",
    targets=[target],
    update=True,
    force=True,
) as e:
    ....
Would this work for you?

That would save the protocol outputs but then I would like to save the data used on the final plotting on another folder

andrea-pasquale · 2024-07-30T14:39:38Z

Using #949 as it is does not allow me to create several path during the for loop for the bias an have all the report separate.

I think that the correct of way of using it would be for you to define an executor for each flux point. Something like:
for bias in biases:
    with Executor.open(
    "myexec",
    path="test_rx_calibration",
    platform="dummy",
    targets=[target],
    update=True,
    force=True,
) as e:
    ....
Would this work for you?
That would save the protocol outputs but then I would like to save the data used on the final plotting on another folder

Ok then you could pass through CLI the folder for the final plot (for example).
Or if for the bias point you do something like "folder_{bias}" you could just have "folder" for the final plot.

for more information, see https://pre-commit.ci

alecandido · 2024-07-30T17:14:55Z

Or if for the bias point you do something like "folder_{bias}" you could just have "folder" for the final plot.

Indeed:

each Executor has one folder, where all its output is stored, for all the protocols executed
the report function just takes a path to an Executor folder, and generates a report with all the protocols in there

So, you have two options:

use many executors (or update many times its path attribute) and generate many output folders, out of which generating many reports (with one call to the report() function for each of them)
use a single executor, but change id to the various protocols, to save all of them in separate subfolders of the same root one, and then generate a single report (with one report() invocation) containing all the protocols

Intermediate options are available as well, since you can batch them the way you prefer.

Which one is the most convenient depends on the use case. For a limited range of values, which will be used altogether (e.g. comparing them), I'd go for option 2.. If instead you have many values, I'd organize them according to some hierarchy (which in principle could be done even with 2., but you should filter them manually during reports' generation, which is not available in a user-friendly way).

Jacfomg · 2024-07-31T08:10:14Z

Or if for the bias point you do something like "folder_{bias}" you could just have "folder" for the final plot.

Indeed:

each Executor has one folder, where all its output is stored, for all the protocols executed

the report function just takes a path to an Executor folder, and generates a report with all the protocols in there

So, you have two options:

use many executors (or update many times its path attribute) and generate many output folders, out of which generating many reports (with one call to the report() function for each of them)

use a single executor, but change id to the various protocols, to save all of them in separate subfolders of the same root one, and then generate a single report (with one report() invocation) containing all the protocols

Intermediate options are available as well, since you can batch them the way you prefer.

Which one is the most convenient depends on the use case. For a limited range of values, which will be used altogether (e.g. comparing them), I'd go for option 2.. If instead you have many values, I'd organize them according to some hierarchy (which in principle could be done even with 2., but you should filter them manually during reports' generation, which is not available in a user-friendly way).

I will go with the 1st with the small fix of defining a first unused executed to get some qubit parameters from the platform instead of defining them at every executor

…into script_coherence

alecandido · 2024-07-31T08:16:47Z

I will go with the 1st with the small fix of defining a first unused executed to get some qubit parameters from the platform instead of defining them at every executor

You can also instantiate the platform without an executor :)

alecandido · 2024-07-31T08:19:17Z

You can also instantiate the platform without an executor :)

And, in that case, you will receive a platform with all targets, so you can just query those you want, without instantiating over and over for each target (btw, this is also true for the executor: it executes the routines for a specific target, but its platform always contains all possible targets).

alecandido

Quick look at the first script

runcards/coherence_flux.py

alecandido · 2024-07-31T08:59:17Z

runcards/coherence_flux.py

+@dataclass
+class CoherenceFluxSignalData(Data):
+    """Coherence acquisition outputs."""
+
+    data: dict[QubitId, npt.NDArray] = field(default_factory=dict)
+    """Raw data acquired."""


My vote goes for skipping the 1-parameter class (there is not even any method associated, so it is truly a wrapper, not even used for the type...)

Jacfomg · 2024-07-31T09:14:15Z

Quick look at the first script

Regarding the CoherenceFluxSignalData I'm using it since I felt using the data.register_qubit is convenient

Jacfomg · 2024-09-20T07:23:54Z

because of #981 I can close it.

alecandido and others added 10 commits July 29, 2024 23:32

feat: Add context manager to start execution

26e172f

feat: Expose update toggle for scripts

e9d6852

fix: Make use of update parameter, leave it unaltered by default

69a3dea

test: Make single shot script example close to minimal

7f969f8

docs: Document minimal script example

fa232cd

test: Make platform explicit, make use of routine result

312ec56

To be more explicit as an example and template

test: Replace magic imports with explicitly executor-scoped routines

fc0aac8

feat: Expose missing action attributes to scripts

972a65f

test: Replace repeated updates with global option

09064f3

feat: Coherence Flux

2164de6

Jacfomg changed the title ~~feat: Coherence Flux~~ Coherence Flux Jul 30, 2024

andrea-pasquale reviewed Jul 30, 2024

View reviewed changes

Jacfomg and others added 3 commits July 30, 2024 18:55

fix : comments

0f733aa

fix: Furtther comments

b7c7c33

[pre-commit.ci] auto fixes from pre-commit.com hooks

b1c82d1

for more information, see https://pre-commit.ci

Jacfomg added 2 commits July 31, 2024 12:15

fix: Coherence Flux plotting and paths

6a71ca5

Merge branch 'script_coherence' of https://github.com/qiboteam/qibocal …

31be4e4

…into script_coherence

Jacfomg added 3 commits July 31, 2024 12:20

fix: remove executor for platform

1dd9f53

fix: remove history reset

f5c8768

feat: T1 errors flux

13cca48

Jacfomg marked this pull request as ready for review July 31, 2024 08:41

Jacfomg requested a review from alecandido July 31, 2024 08:41

Jacfomg requested a review from Edoardo-Pedicillo July 31, 2024 08:41

alecandido reviewed Jul 31, 2024

View reviewed changes

fix: comments

142255d

Jacfomg mentioned this pull request Jul 31, 2024

Example scripts #951

Closed

8 tasks

alecandido force-pushed the exec-ctx-manager branch from 09ac57a to 5683fe4 Compare August 2, 2024 18:01

alecandido force-pushed the exec-ctx-manager branch from 5683fe4 to 40153aa Compare August 10, 2024 17:34

andrea-pasquale added the experiment Related to an individual protocol label Aug 12, 2024

alecandido force-pushed the exec-ctx-manager branch from 40153aa to 970776b Compare August 13, 2024 05:20

Base automatically changed from exec-ctx-manager to main August 13, 2024 09:43

andrea-pasquale added the do not merge Soft warning to avoid merging a PR for reason provided in the PR label Aug 14, 2024

Edoardo-Pedicillo mentioned this pull request Sep 11, 2024

Update flux script #981

Closed

8 tasks

Jacfomg closed this Sep 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Coherence Flux #954

Coherence Flux #954

Jacfomg commented Jul 30, 2024

codecov bot commented Jul 30, 2024 •

edited

Loading

andrea-pasquale left a comment

andrea-pasquale Jul 30, 2024

Jacfomg Jul 30, 2024

alecandido Jul 31, 2024

andrea-pasquale Jul 30, 2024

Jacfomg Jul 30, 2024 •

edited

Loading

andrea-pasquale commented Jul 30, 2024 •

edited

Loading

Jacfomg commented Jul 30, 2024

andrea-pasquale commented Jul 30, 2024

alecandido commented Jul 30, 2024

Jacfomg commented Jul 31, 2024

alecandido commented Jul 31, 2024

alecandido commented Jul 31, 2024

alecandido left a comment

alecandido Jul 31, 2024

Jacfomg commented Jul 31, 2024

Jacfomg commented Sep 20, 2024

Coherence Flux #954

Coherence Flux #954

Conversation

Jacfomg commented Jul 30, 2024

codecov bot commented Jul 30, 2024 • edited Loading

Codecov Report

andrea-pasquale left a comment

Choose a reason for hiding this comment

andrea-pasquale Jul 30, 2024

Choose a reason for hiding this comment

Jacfomg Jul 30, 2024

Choose a reason for hiding this comment

alecandido Jul 31, 2024

Choose a reason for hiding this comment

andrea-pasquale Jul 30, 2024

Choose a reason for hiding this comment

Jacfomg Jul 30, 2024 • edited Loading

Choose a reason for hiding this comment

andrea-pasquale commented Jul 30, 2024 • edited Loading

Jacfomg commented Jul 30, 2024

andrea-pasquale commented Jul 30, 2024

alecandido commented Jul 30, 2024

Jacfomg commented Jul 31, 2024

alecandido commented Jul 31, 2024

alecandido commented Jul 31, 2024

alecandido left a comment

Choose a reason for hiding this comment

alecandido Jul 31, 2024

Choose a reason for hiding this comment

Jacfomg commented Jul 31, 2024

Jacfomg commented Sep 20, 2024

codecov bot commented Jul 30, 2024 •

edited

Loading

Jacfomg Jul 30, 2024 •

edited

Loading

andrea-pasquale commented Jul 30, 2024 •

edited

Loading