1096 clean up code and examples follow up (#1097)

* made test local

* moved hydrolib examples from scripts to notebook

* moved hisfile examples from script to notebooks

* restructured tests

Author: veenstrajelmer

docs/notebooks/postprocessing_example.ipynb

@@ -6,6 +6,10 @@
    "metadata": {},
    "source": [
     "# Post-processing example Delft3D4\n",
+    "To get Delft3D4 to write netCDF output instead of .dat files, add these lines to your model settings file (.mdf):\n",
+    "- `FlNcdf= #maphis#`\n",
+    "- `ncFormat=4`\n",
+    "\n",
     "If you prefer to interact with a Python script instead, you can convert this notebook to *.py with `jupyter nbconvert --to script postprocessing_example_delft3d4.ipynb`.\n"
    ]
   },
@@ -16,14 +20,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# for Delft3D FM examples, https://github.com/Deltares/dfm_tools/blob/main/docs/notebooks/postprocessing_example.ipynb\n",
-    "# to get Delft3D4 to write netCDF output instead of .dat files, add these lines to your mdf:\n",
-    "#    FlNcdf= #maphis#\n",
-    "#    ncFormat=4\n",
-    "\n",
+    "# imports\n",
     "import matplotlib.pyplot as plt\n",
     "plt.close('all')\n",
-    "import dfm_tools as dfmt\n"
+    "import dfm_tools as dfmt\n",
+    "import xarray as xr\n"
    ]
   },
   {
@@ -38,50 +39,97 @@
     "model = 'westernscheldt' # 'kivu', 'curvedbend', 'westernscheldt'\n",
     "\n",
     "if model == 'curvedbend':\n",
-    "    file_nc = dfmt.data.d3d_curvedbend_trim(return_filepath=True)\n",
+    "    file_map = dfmt.data.d3d_curvedbend_trim(return_filepath=True)\n",
+    "    file_his = dfmt.data.d3d_curvedbend_trih(return_filepath=True)\n",
     "    timestep = 4\n",
     "    layno = -1\n",
     "    res = 100\n",
     "    scale = 25\n",
     "    figsize = (6,5)\n",
     "    add_coastlines = False\n",
+    "    stations_requested = ['Outer-south', 'inner-south', 'inner-middle']\n",
     "elif model == 'westernscheldt':\n",
-    "    file_nc = dfmt.data.d3d_westernscheldt_trim(return_filepath=True)\n",
+    "    file_map = dfmt.data.d3d_westernscheldt_trim(return_filepath=True)\n",
+    "    file_his = None\n",
     "    timestep = 10\n",
     "    layno = 0\n",
     "    res = 1/70\n",
     "    scale = 30\n",
     "    figsize = (10,4)\n",
     "    add_coastlines = True\n",
+    "    stations_requested = []\n",
     "elif model == 'kivu':\n",
-    "    file_nc = r'p:\\archivedprojects\\1220688-lake-kivu\\3_modelling\\1_FLOW\\7_heatfluxinhis\\062_netcdf\\trim-thiery_002_coarse.nc'\n",
+    "    file_map = r'p:\\archivedprojects\\1220688-lake-kivu\\3_modelling\\1_FLOW\\7_heatfluxinhis\\062_netcdf\\trim-thiery_002_coarse.nc'\n",
+    "    file_his = r'p:\\archivedprojects\\1220688-lake-kivu\\3_modelling\\1_FLOW\\7_heatfluxinhis\\063_netcdf\\trih-thiery_002_coarse.nc'\n",
     "    timestep = 10\n",
     "    layno = -2\n",
     "    res = 1/70\n",
     "    scale = 3\n",
     "    figsize = (6,7)\n",
     "    add_coastlines = True\n",
+    "    stations_requested = ['ADCP1_final','ADCP2_final','KP1_016']\n",
     "else:\n",
     "    raise Exception(f'undefined model: {model}')\n"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 3,
+   "id": "163bf92c-4905-4091-9685-ece1773997a7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# open Delft3D4 netcdf his dataset\n",
+    "if file_his:\n",
+    "    data_xr = xr.open_mfdataset(file_his, preprocess=dfmt.preprocess_hisnc)\n",
+    "    vars_pd = dfmt.get_ncvarproperties(data_xr)\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "b481b84c-90ce-47a9-b2aa-cae9a10917c0",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# plot waterlevel from hisfile\n",
+    "if file_his:\n",
+    "    da_zws = data_xr.ZWL.sel(NOSTAT=stations_requested)\n",
+    "    fig, ax = plt.subplots(figsize=(10,6))\n",
+    "    da_zws.plot.line('-', ax=ax, x='time')\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "7916acf2-1421-44e3-847f-c8b0ab85386f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# plot u velocity from hisfile\n",
+    "if file_his:\n",
+    "    da_dps = data_xr.ZCURU.sel(NOSTAT=stations_requested).isel(KMAXOUT_RESTR=0)\n",
+    "    fig, ax = plt.subplots(figsize=(10,6))\n",
+    "    da_dps.plot.line('-', ax=ax, x='time')\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
    "id": "1a63798c-55ce-4e0b-8964-184986816d97",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      ">> rasterizing ugrid Dataset with 12 face variables to shape=(20,70): 0.50 sec\n"
+      ">> rasterizing ugrid Dataset with 12 face variables to shape=(20,70): 0.45 sec\n"
      ]
     }
    ],
    "source": [
-    "# open delft3d4 netcdf dataset\n",
-    "uds = dfmt.open_dataset_delft3d4(file_nc)\n",
+    "# open Delft3D4 netcdf map dataset\n",
+    "uds = dfmt.open_dataset_delft3d4(file_map)\n",
     "# select timestep\n",
     "uds_sel = uds.isel(time=timestep,KMAXOUT_RESTR=layno)\n",
     "# rasterize (for vector plots)\n",
@@ -90,15 +138,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 7,
    "id": "fdf5cfcb-67a1-4e00-873c-c12206571106",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      ">> reading coastlines: 1.37 sec\n"
+      ">> reading coastlines: 1.31 sec\n"
      ]
     },
     {
@@ -122,15 +170,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 8,
    "id": "0c3a7d7d-2c06-4b3d-97b2-3a2cf53e30e0",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      ">> reading coastlines: 0.73 sec\n"
+      ">> reading coastlines: 0.68 sec\n"
      ]
     },
     {
@@ -154,15 +202,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 9,
    "id": "eccce136-29aa-4864-92f3-f20dfd92b82c",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      ">> reading coastlines: 1.31 sec\n"
+      ">> reading coastlines: 0.73 sec\n"
      ]
     },
     {
@@ -188,15 +236,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 10,
    "id": "ca644dd6-1e8a-4fb4-93c9-a9407a95a778",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      ">> reading coastlines: 1.30 sec\n"
+      ">> reading coastlines: 0.70 sec\n"
      ]
     },
     {