Merge pull request #10 from OpenQuantumDesign/table-and-folder

Support for table and document data

Author: yhteoh

.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

@@ -175,3 +175,4 @@ cython_debug/
 *.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.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/base.md

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