Upload README.md with huggingface_hub

README.md

@@ -1,4 +1,11 @@
 ---
+license: cc-by-sa-4.0
+task_categories:
+- graph-ml
+pretty_name: 2D quasistatic non-linear structural mechanics solutions
+tags:
+- physics learning
+- geometry learning
 dataset_info:
   features:
   - name: Base_2_2/Zone
@@ -75,3 +82,54 @@ configs:
   - split: OOD
     path: data/OOD-*
 ---
+![image/png](https://i.ibb.co/MDqsmb5H/Logo-Tensile2d-2-consolas-100.png)
+![image/png](https://i.ibb.co/Js062hF/preview.png)
+data_production:
+  physics: 2D quasistatic non-linear structural mechanics, small deformations, plane
+    strain
+  type: simulation
+legal:
+  license: CC-BY-SA
+  owner: Safran
+plaid:
+  version: 0.1.10.dev114+gcbd3fd46f.d20251014
+
+Example of commands:
+```python
+from datasets import load_dataset
+from plaid.bridges import huggingface_bridge
+
+repo_id = "chanel/dataset"
+
+# Load the dataset
+hf_datasetdict = load_dataset(repo_id)
+
+# Load addition required data
+flat_cst, key_mappings = huggingface_bridge.load_tree_struct_from_hub(repo_id)
+pb_def = huggingface_bridge.load_problem_definition_from_hub(repo_id, pb_def_names[0])
+infos = huggingface_bridge.load_infos_from_hub(repo_id)
+
+# Efficient reconstruct plaid samples
+for split_name, hf_dataset in hf_datasetdict.items():
+    for i in range(len(hf_dataset)):
+        sample = huggingface_bridge.to_plaid_sample(
+            hf_datasetdict[split_names[0]],
+            i,
+            flat_cst[split_names[0]],
+            key_mappings["cgns_types"],
+        )
+
+# Extract input and output features from samples:
+for t in sample.get_all_mesh_times():
+    for path in pb_def.get_in_features_identifiers():
+        sample.get_feature_by_path(path=path, time=t)
+    for path in pb_def.get_out_features_identifiers():
+        sample.get_feature_by_path(path=path, time=t)
+```
+This dataset was generated in [PLAID](https://plaid-lib.readthedocs.io/), we refer to this documentation for additional details on how to data data from samples.
+
+### Dataset Sources
+
+- **Papers:**
+   - [arxiv](https://arxiv.org/pdf/2305.12871)
+   - [arxiv](https://arxiv.org/abs/2505.02974)