Merge pull request #11 from PLAID-lib/main_s

Main s

Author: casenave

docs/source/notebooks/dataset.ipynb

@@ -25,8 +25,8 @@
    "outputs": [],
    "source": [
     "# Import required libraries\n",
-    "import numpy as np\n",
-    "import os"
+    "from pathlib import Path\n",
+    "import numpy as np"
    ]
   },
   {
@@ -40,6 +40,7 @@
     "from Muscat.Bridges.CGNSBridge import MeshToCGNS\n",
     "from Muscat.Containers import MeshCreationTools as MCT\n",
     "\n",
+    "import plaid\n",
     "from plaid.containers.dataset import Dataset\n",
     "from plaid.containers.sample import Sample"
    ]
@@ -614,9 +615,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "empty_ds = Dataset()\n",
-    "nb_samples = empty_ds._load_number_of_samples_(tmpdir)\n",
-    "\n",
+    "nb_samples = plaid.get_number_of_samples(tmpdir)\n",
     "print(f\"{nb_samples = }\")"
    ]
   },
@@ -696,8 +695,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "tmpdir = f'/tmp/test_safe_to_delete_{np.random.randint(1e10,1e12)}'\n",
-    "tmpfile = os.path.join(tmpdir, 'test_file.plaid')\n",
+    "tmpdir = Path(f'/tmp/test_safe_to_delete_{np.random.randint(1e10,1e12)}')\n",
+    "tmpfile = tmpdir / 'test_file.plaid'\n",
     "\n",
     "print(f\"Save dataset in: {tmpfile}\")\n",
     "dataset.save(tmpfile)"

examples/containers/dataset_example.py

@@ -23,6 +23,7 @@
 from Muscat.Bridges.CGNSBridge import MeshToCGNS
 from Muscat.Containers import MeshCreationTools as MCT
 
+import plaid
 from plaid.containers.dataset import Dataset
 from plaid.containers.sample import Sample
 
@@ -339,10 +340,18 @@ def dprint(name: str, dictio: dict, end: str = "\n"):
 # ### Get the number of Samples that can be loaded from a directory
 
 # %%
-nb_samples = Dataset._load_number_of_samples_(tmpdir)
+nb_samples = plaid.get_number_of_samples(tmpdir)
 
 print(f"{nb_samples = }")
 
+# %% [markdown]
+# ### Get the Samples ids that can be loaded from a directory
+
+# %%
+sample_ids = plaid.get_sample_ids(tmpdir)
+
+print(f"{sample_ids = }")
+
 # %% [markdown]
 # ### Load a Dataset from a directory via initialization
 

src/plaid/__init__.py

@@ -10,4 +10,6 @@
 except ImportError:
     __version__ = "None"
 
-__all__ = ["__version__"]
+__all__ = ["__version__"]
+
+from .containers.utils import get_number_of_samples, get_sample_ids