QuLab 2.5.0__cp311-cp311-win_amd64.whl → 2.5.2__cp311-cp311-win_amd64.whl

{QuLab-2.5.0.dist-info → QuLab-2.5.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: QuLab
-Version: 2.5.0
+Version: 2.5.2
 Summary: contral instruments and manage data
 Author-email: feihoo87 <feihoo87@gmail.com>
 Maintainer-email: feihoo87 <feihoo87@gmail.com>

{QuLab-2.5.0.dist-info → QuLab-2.5.2.dist-info}/RECORD

@@ -1,18 +1,19 @@
 qulab/__init__.py,sha256=pdlicy07Dx39pTEGZ0i41Ox9tuuuKKIdsFIrE13bneg,249
 qulab/__main__.py,sha256=FL4YsGZL1jEtmcPc5WbleArzhOHLMsWl7OH3O-1d1ss,72
 qulab/dicttree.py,sha256=ZoSJVWK4VMqfzj42gPb_n5RqLlM6K1Me0WmLIfLEYf8,14195
-qulab/fun.cp311-win_amd64.pyd,sha256=Ou3oaF6r91_RUTvb-1Qc5yorMZQpcgdsW36pPtNCiN8,31744
-qulab/version.py,sha256=b9PgnIDmp0TYLJmDYb-w9iqcfWXZk22bBNQQjBVgaf0,21
+qulab/fun.cp311-win_amd64.pyd,sha256=8Hmaqbu11gSeCoSaAA4pC4Dw-1yDNDLE38JdtpLVTg4,31744
+qulab/typing.py,sha256=3c0eKa1avEHIi5wPvh3-4l6Of5mu5Rn1MWPnMeLGNX0,71
+qulab/version.py,sha256=w6piXlEvrVvbn_4rTzwW2-HxvwxuHYQ5nIl8vcMmXAs,21
 qulab/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 qulab/cli/commands.py,sha256=6xd2eYw32k1NmfAuYSu__1kaP12Oz1QVqwbkYXdWno4,588
 qulab/cli/config.py,sha256=tNmH4ggdgrFqcQa2WZKLpidiYTg95_UnT0paDJ4fi4c,3204
 qulab/executor/__init__.py,sha256=LosPzOMaljSZY1thy_Fxtbrgq7uubJszMABEB7oM7tU,101
 qulab/executor/cli.py,sha256=owdDSaSuzTPQA5SlNCxX4nHWITU1BF0VZMj7tLqCZhM,5781
-qulab/executor/load.py,sha256=4QJI_jWUCrn0MW_ieTAyhUXmujrOU5D9ywSOqzNduu0,11992
-qulab/executor/schedule.py,sha256=u-eM9Cw8GrvWmRFhHQWSXcdKomxp6AqSwnSm3gDwkrM,11920
-qulab/executor/storage.py,sha256=V91y8z62GseJLm2-1k-empbw68pCq93Lk-nUAwtfVfs,6068
-qulab/executor/transform.py,sha256=inaOn6eqCs22ZZ0xAQl8s8YCoEACaXSwFNNu7jqdwAk,2148
-qulab/executor/utils.py,sha256=OVBYuAC4Pw8-kT_s0AJUiLAS5QTeV-mXF8zjdQFTwrM,3163
+qulab/executor/load.py,sha256=i2MKxE5kflAGLt3e9LjME59K7IO7s68EUApP9228LhQ,12125
+qulab/executor/schedule.py,sha256=4D8o68Cx6vCkpSTMHzULTwuuq1tS8unc2n8WdBA9oB0,12013
+qulab/executor/storage.py,sha256=s1xrI4bPTnyM4Nj0CkPxr3NdmnSp18LKnwm-ZoxR-Q0,7191
+qulab/executor/transform.py,sha256=AazWdlkEoOBaUJpTYsT5J4f0RanzCEeo-ThwEg8BB4Y,1262
+qulab/executor/utils.py,sha256=RNDEo17M-n_tge7uLITHxmoNNYSTm9OES75wQygR8dM,4065
 qulab/monitor/__init__.py,sha256=xEVDkJF8issrsDeLqQmDsvtRmrf-UiViFcGTWuzdlFU,43
 qulab/monitor/__main__.py,sha256=k2H1H5Zf9LLXTDLISJkbikLH-z0f1e5i5i6wXXYPOrE,105
 qulab/monitor/config.py,sha256=y_5StMkdrbZO1ziyKBrvIkB7Jclp9RCPK1QbsOhCxnY,785
@@ -92,9 +93,9 @@ qulab/visualization/plot_seq.py,sha256=Uo1-dB1YE9IN_A9tuaOs9ZG3S5dKDQ_l98iD2Wbxp
 qulab/visualization/qdat.py,sha256=HubXFu4nfcA7iUzghJGle1C86G6221hicLR0b-GqhKQ,5887
 qulab/visualization/rot3d.py,sha256=jGHJcqj1lEWBUV-W4GUGONGacqjrYvuFoFCwPse5h1Y,757
 qulab/visualization/widgets.py,sha256=HcYwdhDtLreJiYaZuN3LfofjJmZcLwjMfP5aasebgDo,3266
-QuLab-2.5.0.dist-info/LICENSE,sha256=b4NRQ-GFVpJMT7RuExW3NwhfbrYsX7AcdB7Gudok-fs,1086
-QuLab-2.5.0.dist-info/METADATA,sha256=dUio4DApvpQRgt7j7w3aYyCqfxDqpbsnTmFuMQirwXw,3803
-QuLab-2.5.0.dist-info/WHEEL,sha256=yNnHoQL2GZYIUXm9YvoaBpFjGlUoK9qq9oqYeudrWlE,101
-QuLab-2.5.0.dist-info/entry_points.txt,sha256=b0v1GXOwmxY-nCCsPN_rHZZvY9CtTbWqrGj8u1m8yHo,45
-QuLab-2.5.0.dist-info/top_level.txt,sha256=3T886LbAsbvjonu_TDdmgxKYUn939BVTRPxPl9r4cEg,6
-QuLab-2.5.0.dist-info/RECORD,,
+QuLab-2.5.2.dist-info/LICENSE,sha256=b4NRQ-GFVpJMT7RuExW3NwhfbrYsX7AcdB7Gudok-fs,1086
+QuLab-2.5.2.dist-info/METADATA,sha256=pnurTFKwe9JZowgcw9DVam-rmQLxNclnXUvWIk314GI,3803
+QuLab-2.5.2.dist-info/WHEEL,sha256=yNnHoQL2GZYIUXm9YvoaBpFjGlUoK9qq9oqYeudrWlE,101
+QuLab-2.5.2.dist-info/entry_points.txt,sha256=b0v1GXOwmxY-nCCsPN_rHZZvY9CtTbWqrGj8u1m8yHo,45
+QuLab-2.5.2.dist-info/top_level.txt,sha256=3T886LbAsbvjonu_TDdmgxKYUn939BVTRPxPl9r4cEg,6
+QuLab-2.5.2.dist-info/RECORD,,

qulab/executor/load.py

@@ -40,17 +40,21 @@ class SetConfigWorkflow():
             value = transform.query_config(self.key)
         except:
             value = eval(input(f'"{self.key}": '))
-        return self.key, value
+        return value
 
-    def analyze(self, key, value, history):
-        return 'OK', {key: value}, {}
+    def analyze(self, result: Result, history: Result):
+        result.state = 'OK'
+        result.parameters = {self.key: result.data}
+        return result
 
     def check(self):
         from .transform import query_config
-        return self.key, query_config(self.key)
+        return query_config(self.key)
 
-    def check_analyze(self, key, value, history):
-        return 'Out of Spec', {key: value}, {}
+    def check_analyze(self, result: Result, history: Result):
+        result.state = 'Outdated'
+        result.parameters = {self.key: result.data}
+        return result
 
     @staticmethod
     def _equal(a, b):

qulab/executor/schedule.py

@@ -5,10 +5,10 @@ from pathlib import Path
 
 from loguru import logger
 
-from . import transform
 from .load import WorkflowType, get_dependents
 from .storage import (Result, find_result, renew_result, revoke_result,
                       save_result)
+from .transform import update_parameters
 
 
 class CalibrationFailedError(Exception):
@@ -66,27 +66,26 @@ def check_state(workflow: WorkflowType, code_path: str | Path,
     return True
 
 
-def call_analyzer(node, data, history, check=False, plot=False):
+def call_analyzer(node,
+                  result: Result,
+                  history: Result | None,
+                  check=False,
+                  plot=False) -> Result:
     if check:
-        result = transform.params_to_result(
-            node.check_analyze(*data,
-                               history=transform.result_to_params(history)))
+        result = node.check_analyze(result, history=history)
         result.fully_calibrated = False
     else:
-        result = transform.params_to_result(
-            node.analyze(*data, history=transform.result_to_params(history)))
+        result = node.analyze(result, history=history)
         result.fully_calibrated = True
         if plot:
             call_plot(node, result)
-    result.data = data
     return result
 
 
 @logger.catch()
-def call_plot(node, result, check=False):
+def call_plot(node, result: Result, check=False):
     if hasattr(node, 'plot') and callable(node.plot):
-        state, params, other = transform.result_to_params(result)
-        node.plot(state, params, other)
+        node.plot(result)
 
 
 @functools.lru_cache(maxsize=128)
@@ -128,7 +127,11 @@ def check_data(workflow: WorkflowType, code_path: str | Path,
         #save_result(workflow.__workflow_id__, result, state_path)
 
         logger.debug(f'Checked "{workflow.__workflow_id__}" !')
-        result = call_analyzer(workflow, data, history, check=True, plot=plot)
+        result = call_analyzer(workflow,
+                               result,
+                               history,
+                               check=True,
+                               plot=plot)
         if result.in_spec:
             logger.debug(
                 f'"{workflow.__workflow_id__}": checked in spec, renewing result'
@@ -149,7 +152,11 @@ def check_data(workflow: WorkflowType, code_path: str | Path,
         save_result(workflow.__workflow_id__, result, state_path)
 
         logger.debug(f'Calibrated "{workflow}" !')
-        result = call_analyzer(workflow, data, history, check=False, plot=plot)
+        result = call_analyzer(workflow,
+                               result,
+                               history,
+                               check=False,
+                               plot=plot)
         save_result(workflow.__workflow_id__,
                     result,
                     state_path,
@@ -169,7 +176,7 @@ def calibrate(workflow: WorkflowType, code_path: str | Path,
     result.data = data
     save_result(workflow.__workflow_id__, result, state_path)
     logger.debug(f'Calibrated "{workflow.__workflow_id__}" !')
-    result = call_analyzer(workflow, data, history, check=False, plot=plot)
+    result = call_analyzer(workflow, result, history, check=False, plot=plot)
     save_result(workflow.__workflow_id__, result, state_path, overwrite=True)
     return result
 
@@ -228,7 +235,7 @@ def diagnose(workflow: WorkflowType, code_path: str | Path,
         raise CalibrationFailedError(
             f'"{workflow.__workflow_id__}": All dependents passed, but calibration failed!'
         )
-    transform.update_parameters(result)
+    update_parameters(result)
     return True
 
 
@@ -284,7 +291,7 @@ def maintain(workflow: WorkflowType,
             f'"{workflow.__workflow_id__}": All dependents passed, but calibration failed!'
         )
     if update:
-        transform.update_parameters(result)
+        update_parameters(result)
     return
 
 
@@ -306,5 +313,5 @@ def run(workflow: WorkflowType,
             f'"{workflow.__workflow_id__}": All dependents passed, but calibration failed!'
         )
     if update:
-        transform.update_parameters(result)
+        update_parameters(result)
     return

qulab/executor/storage.py

@@ -4,6 +4,7 @@ import uuid
 from dataclasses import dataclass, field
 from datetime import datetime, timedelta
 from pathlib import Path
+from typing import Any, Literal
 
 from loguru import logger
 
@@ -18,9 +19,9 @@ class Result():
     calibrated_time: datetime = field(default_factory=datetime.now)
     checked_time: datetime = field(default_factory=datetime.now)
     ttl: timedelta = timedelta(days=3650)
-    params: dict = field(default_factory=dict)
-    info: dict = field(default_factory=dict)
-    data: tuple = field(default_factory=tuple)
+    parameters: dict = field(default_factory=dict)
+    other_infomation: dict = field(default_factory=dict)
+    data: Any = field(default_factory=tuple)
     index: int = -1
     previous_path: Path | None = None
     base_path: Path | None = None
@@ -32,6 +33,37 @@ class Result():
         else:
             return None
 
+    @property
+    def state(self) -> Literal['OK', 'Bad', 'Outdated']:
+        state = 'Bad'
+        match (self.in_spec, self.bad_data):
+            case (True, False):
+                state = 'OK'
+            case (False, True):
+                state = 'Bad'
+            case (False, False):
+                state = 'Outdated'
+        return state
+
+    @state.setter
+    def state(self, state: Literal['OK', 'Bad', 'Outdated', 'In spec',
+                                   'Out of spec', 'Bad data']):
+        if state not in [
+                'OK', 'Bad', 'Outdated', 'In spec', 'Out of spec', 'Bad data'
+        ]:
+            raise ValueError(
+                f'Invalid state: {state}, state must be one of "OK", "Bad" and "Outdated"'
+            )
+        if state in ['In spec', 'OK']:
+            self.in_spec = True
+            self.bad_data = False
+        elif state in ['Bad data', 'Bad']:
+            self.bad_data = True
+            self.in_spec = False
+        else:
+            self.bad_data = False
+            self.in_spec = False
+
 
 def random_path(base: Path) -> Path:
     while True:
@@ -44,7 +76,7 @@ def random_path(base: Path) -> Path:
 def save_result(workflow: str,
                 result: Result,
                 base_path: str | Path,
-                overwrite: bool = False):
+                overwrite: bool = False) -> int:
     logger.debug(
         f'Saving result for "{workflow}", {result.in_spec=}, {result.bad_data=}, {result.fully_calibrated=}'
     )
@@ -70,6 +102,7 @@ def save_result(workflow: str,
         f.write(result.index.to_bytes(8, 'big'))
         f.write(buf)
     set_head(workflow, path, base_path)
+    return result.index
 
 
 def load_result(path: str | Path, base_path: str | Path) -> Result | None:
@@ -99,7 +132,7 @@ def renew_result(workflow: str, base_path: str | Path):
     result = find_result(workflow, base_path)
     if result is not None:
         result.checked_time = datetime.now()
-        save_result(workflow, result, base_path)
+        return save_result(workflow, result, base_path)
 
 
 def revoke_result(workflow: str, base_path: str | Path):
@@ -107,10 +140,9 @@ def revoke_result(workflow: str, base_path: str | Path):
     base_path = Path(base_path)
     path = get_head(workflow, base_path)
     if path is not None:
-        with open(base_path / 'objects' / path, "rb") as f:
-            result = pickle.load(f)
+        result = load_result(path, base_path)
         result.in_spec = False
-        save_result(workflow, result, base_path)
+        return save_result(workflow, result, base_path)
 
 
 def set_head(workflow: str, path: Path, base_path: str | Path):

qulab/executor/transform.py

@@ -1,5 +1,3 @@
-import loguru
-
 from .storage import Result
 
 
@@ -32,40 +30,7 @@ def _update_config(updates):
 
 
 def update_parameters(result: Result):
-    update_config(result.params)
-
-
-def result_to_params(result: Result | None) -> tuple | None:
-    if result is None:
-        return None
-
-    state = 'Bad data'
-    match (result.in_spec, result.bad_data):
-        case (True, False):
-            state = 'In spec'
-        case (False, True):
-            state = 'Bad data'
-        case (False, False):
-            state = 'Out of spec'
-
-    return state, result.params, result.info
-
-
-def params_to_result(params: tuple) -> Result:
-    state, cali, info = params
-    result = Result()
-    if state in ['In spec', 'OK']:
-        result.in_spec = True
-        result.bad_data = False
-    elif state in ['Bad data', 'Bad']:
-        result.bad_data = True
-        result.in_spec = False
-    else:
-        result.bad_data = False
-        result.in_spec = False
-    result.params = cali
-    result.info = info
-    return result
+    update_config(result.parameters)
 
 
 query_config = _query_config

qulab/executor/utils.py

@@ -31,11 +31,12 @@ def dependent_tree(node: str, code_path: str | Path) -> dict[str, list[str]]:
 
 
 def workflow_template(deps: list[str]) -> str:
-    return f"""from loguru import logger
-
-def VAR(s): pass  # 没有实际作用，只是用来抑制编辑器的警告。
+    return f"""def VAR(s): pass  # 没有实际作用，只是用来抑制编辑器的警告。
 
 import numpy as np
+from loguru import logger
+
+from qulab.typing import Result
 
 
 # 多长时间应该检查一次校准实验，单位是秒。
@@ -60,23 +61,35 @@ def calibrate():
     return x, y
 
 
-def analyze(*args, history):
+def analyze(result: Result, history: Result | None) -> Result:
+    \"\"\"
+    分析校准结果。
+
+    result: Result
+        本次校准实验的数据。
+    history: Result | None
+        上次校准实验数据和分析结果，如果有的话。
+    \"\"\"
     import random
 
+    # 这里添加你的分析过程，运行 calibrate 得到的数据，在 result.data 里
+    # 你可以得到校准的结果，然后根据这个结果进行分析。
+    x, y = result.data
+
     # 完整校准后的状态有两种：OK 和 Bad，分别对应校准成功和校准失败。
     # 校准失败是指出现坏数据，无法简单通过重新运行本次校准解决，需要
     # 检查前置步骤。
-    state = random.choice(['OK', 'Bad'])
+    result.state = random.choice(['OK', 'Bad'])
 
     # 参数是一个字典，包含了本次校准得到的参数，后续会更新到config表中。
-    parameters = {{'gate.R.Q1.params.amp':1}}
+    result.parameters = {{'gate.R.Q1.params.amp':1}}
 
     # 其他信息可以是任何可序列化的内容，你可以将你想要记录的信息放在这里。
     # 下次校准分析时，这些信息也会在 history 参数中一起传入，帮助你在下
     # 次分析时对比参考。
-    other_infomation = {{}}
+    result.other_infomation = {{}}
 
-    return state, parameters, other_infomation
+    return result
 
 
 def check():
@@ -95,14 +108,26 @@ def check():
     return x, y
 
 
-def check_analyze(*args, history):
+def check_analyze(result: Result, history: Result) -> Result:
+    \"\"\"
+    分析检查结果。
+
+    result: Result
+        本次检查实验的数据。
+    history: Result | None
+        上次检查实验数据和分析结果，如果有的话。
+    \"\"\"
     import random
 
+    # 这里添加你的分析过程，运行 check 得到的数据，在 result.data 里
+    # 你可以得到校准的结果，然后根据这个结果进行分析。
+    x, y = result.data
+
     # 状态有三种：Outdated, OK, Bad，分别对应过时、正常、坏数据。
     # Outdated 是指数据过时，即参数漂了，需要重新校准。
     # OK 是指数据正常，参数也没漂，不用重新校准。
     # Bad 是指数据坏了，无法校准，需要检查前置步骤。
-    state = random.choice(['Outdated', 'OK', 'Bad'])
+    result.state = random.choice(['Outdated', 'OK', 'Bad'])
 
-    return state, {{}}, {{}}
+    return result
 """

qulab/typing.py

@@ -0,0 +1,2 @@
+from .executor.storage import Result
+from .scan.record import Record

qulab/version.py

@@ -1 +1 @@
-__version__ = "2.5.0"
+__version__ = "2.5.2"