|
1 | | - |
2 | 1 | # Tutorial |
3 | 2 |
|
4 | | -```python |
5 | | -import pathlib |
6 | | - |
7 | | -import numpy as np |
8 | | -from rich.pretty import pprint |
9 | | - |
10 | | -from oqd_dataschema.base import Dataset |
11 | | -from oqd_dataschema.datastore import Datastore |
12 | | -from oqd_dataschema.groups import ( |
13 | | - ExpectationValueDataGroup, |
14 | | - MeasurementOutcomesDataGroup, |
15 | | - SinaraRawDataGroup, |
16 | | -) |
17 | | -``` |
| 3 | +## Group Definition |
18 | 4 |
|
19 | 5 | ```python |
20 | | -raw = SinaraRawDataGroup( |
21 | | - camera_images=Dataset(shape=(3, 2, 2), dtype="float32"), |
22 | | - attrs={"date": "2025-03-26", "version": 0.1}, |
23 | | -) |
24 | | -pprint(raw) |
25 | | -``` |
| 6 | +from oqd_dataschema import GroupBase, Attrs |
26 | 7 |
|
27 | | - |
28 | | - |
29 | | -```python |
30 | | -raw.camera_images.data = np.random.uniform(size=(3, 2, 2)).astype("float32") |
31 | | -pprint(raw) |
| 8 | +class CustomGroup(GroupBase): |
| 9 | + attrs: Attrs = Field( |
| 10 | + default_factory=lambda: dict( |
| 11 | + timestamp=str(datetime.datetime.now(datetime.timezone.utc)) |
| 12 | + ) |
| 13 | + ) |
| 14 | + t: Dataset |
| 15 | + x: Dataset |
32 | 16 | ``` |
33 | 17 |
|
34 | | - |
| 18 | +Defined groups are automatically registered into the [`GroupRegistry`][oqd_dataschema.group.GroupRegistry]. |
35 | 19 |
|
36 | 20 | ```python |
37 | | -raw.camera_images.data = np.random.uniform(size=(3, 2, 2)).astype("float32") |
38 | | -``` |
39 | | - |
| 21 | +from oqd_dataschema import GroupRegistry |
40 | 22 |
|
41 | | - |
42 | | -```python |
43 | | -data = Datastore(groups={"raw": raw}) |
44 | | -pprint(data) |
| 23 | +GroupRegistry.groups |
45 | 24 | ``` |
46 | 25 |
|
47 | | - |
48 | | - |
| 26 | +## Initialize Group |
49 | 27 |
|
50 | 28 | ```python |
51 | | -def process_raw(raw: SinaraRawDataGroup) -> MeasurementOutcomesDataGroup: |
52 | | - processed = MeasurementOutcomesDataGroup( |
53 | | - outcomes=Dataset( |
54 | | - data=np.round(raw.camera_images.data.mean(axis=(1, 2))), |
55 | | - ) |
56 | | - ) |
57 | | - return processed |
| 29 | +t = np.linspace(0, 1, 101).astype(np.float32) |
| 30 | +x = np.sin(t).astype(np.complex64) |
58 | 31 |
|
| 32 | +group = CustomGroup( |
| 33 | + t=Dataset(dtype="float32", shape=(101,)), x=Dataset(dtype="complex64", shape=(101,)) |
| 34 | +) |
59 | 35 |
|
60 | | -processed = process_raw(data.groups["raw"]) |
61 | | -pprint(processed) |
| 36 | +group.t.data = t |
| 37 | +group.x.data = x |
62 | 38 | ``` |
63 | 39 |
|
64 | | - |
65 | | - |
| 40 | +## Initialize Datastore |
66 | 41 |
|
67 | 42 | ```python |
68 | | -data.groups.update(processed=processed) |
69 | | -pprint(data) |
| 43 | +from oqd_datastore import Datastore |
| 44 | + |
| 45 | +datastore = Datastore(groups={"g1": group}) |
70 | 46 | ``` |
71 | 47 |
|
| 48 | +## Data pipeline |
72 | 49 |
|
| 50 | +```python |
| 51 | +def process(datastore) -> Datastore: |
| 52 | + _g = datastore.get("g1") |
73 | 53 |
|
| 54 | + g2 = CustomGroup(t=Dataset(data=_g.t.data), x=Dataset(data=_g.x.data + 1j)) |
74 | 55 |
|
75 | | -```python |
76 | | -def process_outcomes( |
77 | | - measurements: MeasurementOutcomesDataGroup, |
78 | | -) -> ExpectationValueDataGroup: |
79 | | - expval = ExpectationValueDataGroup( |
80 | | - expectation_value=Dataset( |
81 | | - shape=(), |
82 | | - dtype="float32", |
83 | | - data=measurements.outcomes.data.mean(), |
84 | | - attrs={"date": "20", "input": 10}, |
85 | | - ) |
86 | | - ) |
87 | | - return expval |
| 56 | + datastore.add(g2=g2) |
88 | 57 |
|
| 58 | + return datastore |
89 | 59 |
|
90 | | -expval = process_outcomes(processed) |
91 | | -data.groups.update(expval=process_outcomes(data.groups["processed"])) |
92 | 60 |
|
93 | | -pprint(expval) |
| 61 | +datastore.pipe(process) |
94 | 62 | ``` |
95 | 63 |
|
96 | | - |
| 64 | +## Save Datastore |
97 | 65 |
|
98 | 66 | ```python |
99 | | -filepath = pathlib.Path("test.h5") |
100 | | -data.model_dump_hdf5(filepath) |
| 67 | +datastore.model_dump_hdf5(pathlib.Path("datastore.h5"), mode="w") |
101 | 68 | ``` |
102 | 69 |
|
103 | | - |
| 70 | +## Load Datastore |
104 | 71 |
|
105 | 72 | ```python |
106 | | -data_reload = Datastore.model_validate_hdf5(filepath) |
107 | | -pprint(data_reload) |
| 73 | +reloaded_datastore = Datastore.model_validate_hdf5(pathlib.Path("datastore.h5")) |
108 | 74 | ``` |
0 commit comments