[docs] updated tutorials

Author: yhteoh

docs/tutorials/advanced.md

@@ -0,0 +1,82 @@
+# Tutorial
+
+## Group Definition
+
+```python
+from oqd_dataschema import GroupBase, Attrs
+
+class CustomGroup(GroupBase):
+    attrs: Attrs = Field(
+        default_factory=lambda: dict(
+            timestamp=str(datetime.datetime.now(datetime.timezone.utc))
+        )
+    )
+    dset: Dataset
+    tbl: Table
+    fld: Folder
+```
+
+Defined groups are automatically registered into the [`GroupRegistry`][oqd_dataschema.group.GroupRegistry].
+
+```python
+from oqd_dataschema import GroupRegistry
+
+GroupRegistry.groups
+```
+
+## Initialize Group
+
+```python
+from oqd_dataschema import Dataset, Table, Folder, unstructured_to_structured
+
+dset = Dataset(data=np.linspace(0, 1, 101).astype(np.float32))
+tbl = Table(
+    columns=[("t", "float32"), ("x", "complex128")],
+    data=unstructured_to_structured(
+        np.stack([np.linspace(0, 1, 101), np.sin(np.linspace(0, 1, 101))], -1),
+        dtype=np.dtype([("t", np.float32), ("x", np.complex128)]),
+    ),
+)
+fld = Folder(
+    document_schema={"t": "float32", "signal": {"x": "complex128", "y": "complex128"}},
+    data=unstructured_to_structured(
+        np.stack(
+            [
+                np.linspace(0, 1, 101),
+                np.sin(np.linspace(0, 1, 101)),
+                np.cos(np.linspace(0, 1, 101)),
+            ],
+            -1,
+        ),
+        dtype=np.dtype(
+            [
+                ("t", np.float32),
+                ("signal", np.dtype([("x", np.complex128), ("y", np.complex128)])),
+            ]
+        ),
+    ),
+)
+
+
+group = CustomGroup(dset=dset, tbl=tbl, fld=fld)
+```
+
+## Initialize Datastore
+
+```python
+from oqd_datastore import Datastore
+
+datastore = Datastore(groups={"g1": group})
+```
+
+## Save Datastore
+
+```python
+datastore.model_dump_hdf5(pathlib.Path("datastore.h5"), mode="w")
+```
+
+## Load Datastore
+
+```python
+reloaded_datastore = Datastore.model_validate_hdf5(pathlib.Path("datastore.h5"))
+```

docs/tutorials/basic.md

@@ -0,0 +1,73 @@
+# Tutorial
+
+## Group Definition
+
+```python
+from oqd_dataschema import GroupBase, Attrs
+
+class CustomGroup(GroupBase):
+    attrs: Attrs = Field(
+        default_factory=lambda: dict(
+            timestamp=str(datetime.datetime.now(datetime.timezone.utc))
+        )
+    )
+    t: Dataset
+    x: Dataset
+```
+
+Defined groups are automatically registered into the [`GroupRegistry`][oqd_dataschema.group.GroupRegistry].
+
+```python
+from oqd_dataschema import GroupRegistry
+
+GroupRegistry.groups
+```
+
+## Initialize Group
+
+```python
+t = np.linspace(0, 1, 101).astype(np.float32)
+x = np.sin(t).astype(np.complex64)
+
+group = CustomGroup(
+    t=Dataset(dtype="float32", shape=(101,)), x=Dataset(dtype="complex64", shape=(101,))
+)
+
+group.t.data = t
+group.x.data = x
+```
+
+## Initialize Datastore
+
+```python
+from oqd_datastore import Datastore
+
+datastore = Datastore(groups={"g1": group})
+```
+
+## Data pipeline
+
+```python
+def process(datastore) -> Datastore:
+    _g = datastore.get("g1")
+
+    g2 = CustomGroup(t=Dataset(data=_g.t.data), x=Dataset(data=_g.x.data + 1j))
+    g2.attrs["_gen_by_pipe"] = "process"
+
+    datastore.add(g2=g2)
+
+
+datastore.pipe(process)
+```
+
+## Save Datastore
+
+```python
+datastore.model_dump_hdf5(pathlib.Path("datastore.h5"), mode="w")
+```
+
+## Load Datastore
+
+```python
+reloaded_datastore = Datastore.model_validate_hdf5(pathlib.Path("datastore.h5"))
+```

mkdocs.yaml

@@ -18,7 +18,9 @@ extra:
 
 nav:
   - Get Started: index.md
-  - Tutorial: tutorial.md
+  - Tutorials:
+      - Basics: tutorials/basic.md
+      - Datasets/Tables/Folders: tutorials/advanced.md
   - Explanation: explanation.md
   - API Reference:
       - Base: api/base.md