Attribute handling, error handling, Tables, Folders

.gitattributes

@@ -1 +1 @@
-postprocessing/** linguist-vendored
+postprocessing/** linguist-vendored

.github/ISSUE_TEMPLATE.md

@@ -26,4 +26,4 @@
   - Subsystem:
 
 
-* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
+* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)

.github/workflows/check_copyright.yml

@@ -10,6 +10,6 @@ jobs:
       - name: Check license & copyright headers
         uses: viperproject/check-license-header@v2
         with:
-          path: 
+          path:
           config: .github/workflows/check_copyright_config.json
-          # strict: true
+          # strict: true

.github/workflows/check_mkdocs_build.yml

@@ -21,4 +21,4 @@ jobs:
         uses: astral-sh/setup-uv@v4
       # - run: cp -r examples/ docs/examples/
       - run: uv pip install .[docs] --system
-      - run: mkdocs build
+      - run: mkdocs build

.github/workflows/copyright.txt

@@ -10,4 +10,4 @@
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
-# limitations under the License.
+# limitations under the License.

.gitignore

@@ -174,3 +174,5 @@ cython_debug/
 *.h5
 *.code-workspace
 .pre-commit-config.yaml
+_scripts
+.vscode

README.md

@@ -14,7 +14,7 @@ The design goals are to have:
 - Minimizes *a priori* knowledge that is needed of the internal heirarchical structure, reducing friction for users to load data.
 - Transparently return both raw and processed data, where the levels of post-processing can be selected by the user.
 
-To install, 
+To install,
 ```bash
 pip install git+https://github.com/OpenQuantumDesign/oqd-dataschema.git
 ```

docs/api/base.md

@@ -0,0 +1,21 @@
+## Attributes Types
+
+<!-- prettier-ignore -->
+::: oqd_dataschema.base
+    options:
+        heading_level: 3
+        members: [
+            "AttrKey",
+            "Attrs",
+        ]
+
+## Data Types
+
+<!-- prettier-ignore -->
+::: oqd_dataschema.base
+    options:
+        heading_level: 3
+        members: [
+            "DTypes",
+            "DTypeNames",
+        ]

docs/api/datastore.md

@@ -0,0 +1,7 @@
+<!-- prettier-ignore -->
+::: oqd_dataschema.datastore
+    options:
+        heading_level: 3
+        members: [
+            "Datastore",
+        ]

docs/api/group.md

@@ -0,0 +1,8 @@
+<!-- prettier-ignore -->
+::: oqd_dataschema.group
+    options:
+        heading_level: 3
+        members: [
+            "GroupBase",
+            "GroupRegistry",
+        ]

docs/api/groupfield.md

@@ -0,0 +1,53 @@
+<!-- prettier-ignore -->
+::: oqd_dataschema.base
+    options:
+        filters: []
+        heading_level: 3
+        members: [
+            "GroupField",
+        ]
+
+## Dataset
+
+<!-- prettier-ignore -->
+::: oqd_dataschema.dataset
+    options:
+        heading_level: 3
+        members: [
+            "Dataset",
+            "CastDataset",
+        ]
+
+## Table
+
+<!-- prettier-ignore -->
+::: oqd_dataschema.table
+    options:
+        heading_level: 3
+        members: [
+            "Table",
+            "CastTable",
+        ]
+
+## Folder
+
+<!-- prettier-ignore -->
+::: oqd_dataschema.folder
+    options:
+        heading_level: 3
+        members: [
+            "Folder",
+            "CastFolder",
+        ]
+
+## Constrained Group Fields
+
+<!-- prettier-ignore -->
+::: oqd_dataschema.constrained
+    options:
+        heading_level: 3
+        members: [
+            "condataset",
+            "contable",
+            "confolder",
+        ]

docs/api/utils.md

@@ -0,0 +1,10 @@
+## Dataset
+
+<!-- prettier-ignore -->
+::: oqd_dataschema.utils
+    options:
+        heading_level: 3
+        members: [
+            "dict_to_structured",
+            "unstructured_to_structured",
+        ]

docs/explanation.md

@@ -0,0 +1,22 @@
+## Datastore
+
+A [Datastore][oqd_dataschema.datastore.Datastore] represents a HDF5 file of a particular hierarchical structure.
+
+### Hierarchy
+
+```
+/
+├── group1/
+│   └── dataset1
+├── group2/
+│   ├── dataset2
+│   ├── table1
+│   └── folder1
+└── group3/
+    ├── table2
+    └── dataset_dict1/
+        ├── dataset5
+        └── dataset6
+```
+
+The top level of [Datastore][oqd_dataschema.datastore.Datastore] contains multiple [Groups](api/group.md)

docs/index.md

@@ -1,4 +1,4 @@
-# 
+#
 
 <p align="center">
   <img src="img/oqd-logo-black.png#only-light" alt="Logo" style="max-height: 200px;">

docs/stylesheets/admonition_template.css

@@ -14,4 +14,4 @@
     background-color: #FFFFFF;
     -webkit-mask-image: var(--md-admonition-icon--template);
             mask-image: var(--md-admonition-icon--template);
-  }
+  }

docs/stylesheets/admonitions.css

@@ -130,6 +130,3 @@
   -webkit-mask-image: var(--md-admonition-icon--acknowledgement);
   mask-image: var(--md-admonition-icon--acknowledgement);
 }
-
-
-

docs/stylesheets/brand.css

@@ -36,12 +36,12 @@ h1, h2, h3, h4, h5, h6,
 
 
 /* Apply Raleway to all navigation and sidebar elements */
-.md-nav, 
-.md-nav__title, 
-.md-nav__link, 
-.md-header, 
-.md-tabs, 
-.md-sidebar, 
+.md-nav,
+.md-nav__title,
+.md-nav__link,
+.md-header,
+.md-tabs,
+.md-sidebar,
 .md-sidebar__inner,
 .md-nav__item,
 .md-footer,
@@ -79,7 +79,7 @@ h1, h2, h3, h4, h5, h6,
 
 
 /* Light mode nav/ToC font color */
-[data-md-color-scheme="default"] .md-nav, 
+[data-md-color-scheme="default"] .md-nav,
 [data-md-color-scheme="default"] .md-nav__link,
 [data-md-color-scheme="default"] .md-header,
 [data-md-color-scheme="default"] .md-tabs {
@@ -88,7 +88,7 @@ h1, h2, h3, h4, h5, h6,
 }
 
 /* Dark mode nav/ToC font color */
-[data-md-color-scheme="slate"] .md-nav, 
+[data-md-color-scheme="slate"] .md-nav,
 [data-md-color-scheme="slate"] .md-nav__link,
 [data-md-color-scheme="slate"] .md-header,
 [data-md-color-scheme="slate"] .md-tabs {
@@ -113,4 +113,4 @@ h1, h2, h3, h4, h5, h6,
 .md-header .md-tabs__link:hover {
   color: #ffffff !important;
   text-decoration: underline;
-}
+}