notebooks: Add Public API.ipynb

.gitignore

@@ -150,3 +150,6 @@ data.bak/
 data_/
 
 .config_jupyter/
+
+*.zarr/
+*.nc

notebooks/API.ipynb

@@ -132,16 +132,16 @@
    },
    "outputs": [],
    "source": [
-    "#variable, layer, timestamp = \"salt\", 40, ds.time.values[4]\n",
+    "#variable, layer, timestamp = \"salt\", 40, \n",
     "#variable, layer, timestamp = \"depth\", None, None\n",
-    "variable, layer, timestamp = \"zeta\", None, \"max\"\n",
+    "variable, layer, timestamp = \"zeta\", None, ds.time.values[4]\n",
     "\n",
     "# The trimesh is the most basic object. This is what you need to create all the others graphs\n",
     "# It is on this object that you specify the timestamp and/or the layer.\n",
-    "trimesh = api.create_trimesh(ds=ds, variable=variable, timestamp=timestamp, layer=layer)\n",
+    "trimesh = api.create_trimesh(ds=ds.sel(time=timestamp), variable=variable)\n",
     "\n",
     "# The wireframe is the representation of the mesh\n",
-    "wireframe = api.get_wireframe(trimesh=trimesh)\n",
+    "wireframe = api.get_wireframe(trimesh)\n",
     "\n",
     "# The tiles is using the tiling service from Open Street maps\n",
     "tiles =  api.get_tiles() \n",
@@ -183,10 +183,17 @@
    "cell_type": "code",
    "execution_count": null,
    "id": "cd80deda",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
-    "(pointer_dmap + tap_dmap).opts(shared_axes=False)"
+    "import warnings\n",
+    "\n",
+    "with warnings.catch_warnings():\n",
+    "    warnings.simplefilter(\"ignore\")\n",
+    "    \n",
+    "    tap_dmap"
    ]
   },
   {
@@ -205,7 +212,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "thalassa",
    "language": "python",
    "name": "python3"
   },
@@ -219,7 +226,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

notebooks/BBox_filtering.ipynb

@@ -121,6 +121,7 @@
     "\n",
     "filename = \"../tests/data/fort.63.nc\"\n",
     "ds = api.open_dataset(filename)\n",
+    "ds = ds.assign(zeta_max=ds.zeta.max(\"time\"))\n",
     "ds"
    ]
   },
@@ -243,10 +244,8 @@
    "source": [
     "# The full dataset\n",
     "trimesh = api.create_trimesh(\n",
-    "    ds=ds,\n",
-    "    variable=\"zeta\",\n",
-    "    timestamp=\"max\",\n",
-    "    layer=None,\n",
+    "    ds,\n",
+    "    variable=\"zeta_max\",\n",
     ")\n",
     "dmap = api.get_tiles() * api.get_raster(trimesh=trimesh) #* api.get_wireframe(trimesh=trimesh)\n",
     "dmap.opts(width=600, title=\"Full dataset\")"
@@ -264,9 +263,7 @@
     "# The filtered dataset\n",
     "ftrimesh = api.create_trimesh(\n",
     "    ds=fds,\n",
-    "    variable=\"zeta\",\n",
-    "    timestamp=\"max\",\n",
-    "    layer=None,\n",
+    "    variable=\"zeta_max\",\n",
     ")\n",
     "fdmap = api.get_tiles() * api.get_raster(trimesh=ftrimesh) * api.get_wireframe(trimesh=ftrimesh)\n",
     "fdmap.opts(width=600, title=\"Filtered Dataset\")"
@@ -290,7 +287,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "python3",
+   "display_name": "thalassa",
    "language": "python",
    "name": "python3"
   },
@@ -304,7 +301,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.16"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,