Update README.md

README.md

@@ -1918,28 +1918,60 @@ Mesh objects included in samples follow the [CGNS](https://cgns.github.io/) stan
 
 Example of commands:
 ```python
-# Get a sample
-split_names = list(dataset.description["split"].keys())
-print(split_names)
-ids_split_0 = dataset.description["split"]['train']
-sample_0_split_0 = dataset[ids_split_0[0]]["sample"]
-plaid_sample = Sample.model_validate(pickle.loads(sample_0_split_0))
-print("type(plaid_sample) =", type(plaid_sample))
+from datasets import load_dataset
+from plaid.containers.sample import Sample
+import pickle
 
-print("plaid_sample =", plaid_sample)
+# Load the dataset
+hf_dataset = load_dataset("PLAID-datasets/VKI-LS59", split="all_samples")
 
-# Access data from this sample
+# Get split ids
+ids_train = hf_dataset.description["split"]['train']
+ids_test  = hf_dataset.description["split"]['test']
+
+# Get inputs/outputs names
+in_scalars_names = hf_dataset.description["in_scalars_names"]
+out_fields_names = hf_dataset.description["out_fields_names"]
+
+# Get samples
+sample = Sample.model_validate(pickle.loads(hf_dataset[ids_train[0]]["sample"]))
+sample = Sample.model_validate(pickle.loads(hf_dataset[ids_test[0]]["sample"]))
+
+# Examples data retrievals
 for fn in ["sdf", "ro", "rou", "rov", "roe", "nut", "mach"]:
-    print(f"{fn} =", plaid_sample.get_field(fn, base_name="Base_2_2"))
-print("M_iso =", plaid_sample.get_field("M_iso", base_name="Base_1_2"))
-for sn in plaid_sample.get_scalar_names():
-    print(f"{sn} =", plaid_sample.get_scalar(sn))
+    print(f"{fn} =", sample.get_field(fn, base_name="Base_2_2"))
+print("M_iso =", sample.get_field("M_iso", base_name="Base_1_2"))
+for sn in sample.get_scalar_names():
+    print(f"{sn} =", sample.get_scalar(sn))
+
+print("nodes 2D (flow) =", sample.get_nodes(base_name="Base_2_2"))
+print("nodes 1D (blade surface) =", sample.get_nodes(base_name="Base_1_2"))
+print("elements 2D (flow) =", sample.get_elements(base_name="Base_2_2"))
+print("elements 1D (blade surface) =", sample.get_elements(base_name="Base_1_2"))
+print("nodal_tags 2D (flow) =", sample.get_nodal_tags(base_name="Base_2_2"))
+
+# inputs
+nodes = sample.get_nodes(base_name="Base_2_2")
+elements = sample.get_elements(base_name="Base_2_2")
+nodal_tags = sample.get_nodal_tags(base_name="Base_2_2")
+sdf = sample.get_field("sdf", base_name="Base_2_2")
+angle_in = sample.get_scalar("angle_in")
+mach_out = sample.get_scalar("mach_out")
+
+# outputs
+mach = sample.get_field("mach", base_name="Base_2_2")
+nut = sample.get_field("nut", base_name="Base_2_2")
+
+for sn in ["Q", "power", "Pr", "Tr", "eth_is", "angle_out"]:
+    outscalar = sample.get_scalar(sn)
 
-print("nodes 2D (flow) =", plaid_sample.get_nodes(base_name="Base_2_2"))
-print("nodes 1D (blade surface) =", plaid_sample.get_nodes(base_name="Base_1_2"))
-print("elements 2D (flow) =", plaid_sample.get_elements(base_name="Base_2_2"))
-print("elements 1D (blade surface) =", plaid_sample.get_elements(base_name="Base_1_2"))
-print("nodal_tags 2D (flow) =", plaid_sample.get_nodal_tags(base_name="Base_2_2"))
+# Get the mesh and convert it to Muscat
+from Muscat.Bridges import CGNSBridge
+CGNS_tree = sample.get_mesh()
+mesh_fluid = CGNSBridge.CGNSToMesh(CGNS_tree, baseNames=["Base_2_2"])
+print(mesh_fluid)
+mesh_blade = CGNSBridge.CGNSToMesh(CGNS_tree, baseNames=["Base_1_2"])
+print(mesh_blade)
 ```
 
 ## Dataset Details