Merge pull request #401 from gwmod/dev

Release v0.9.1

Author: rubencalje

.gitignore

@@ -145,7 +145,7 @@ cython_debug/
 nlmod/bin/*
 !nlmod/bin/
 !nlmod/bin/mp7_2_002_provisional
-flowchartnlmod.pptx
+nlmod/data/bofek/*
 
 tests/data/*
 !tests/data/**/

.readthedocs.yml

@@ -7,9 +7,9 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-lts-latest
   tools:
-    python: "3.10"
+    python: "3.11"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

docs/examples/03_local_grid_refinement.ipynb

@@ -260,7 +260,7 @@
     "plan_weg_gdf.plot(ax=ax, color=\"r\", label=\"Planetenweg\")\n",
     "ax.set_xlim(100000, 103000)\n",
     "ax.set_ylim(495000, 497500)\n",
-    "ax.legend()"
+    "ax.legend();"
    ]
   },
   {
@@ -292,9 +292,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "ds[\"vertices\"] = nlmod.grid.get_vertices(ds)\n",
-    "\n",
-    "fig, axes = nlmod.plot.get_map(extent, nrows=2, ncols=2, figsize=(14, 11))\n",
+    "fig, axes = nlmod.plot.get_map(extent, nrows=2, ncols=2, figsize=14)\n",
     "\n",
     "nlmod.plot.data_array(ds[\"ahn\"], ds, ax=axes[0][0])\n",
     "nlmod.plot.data_array(ds[\"botm\"][0], ds, ax=axes[0][1])\n",
@@ -305,7 +303,7 @@
     "nlmod.plot.data_array(ds[\"bathymetry\"], ds, ax=axes[0][0])\n",
     "nlmod.plot.data_array(ds[\"northsea\"], ds, ax=axes[0][1])\n",
     "nlmod.plot.data_array(ds[\"kh\"][1], ds, ax=axes[1][0])\n",
-    "nlmod.plot.data_array(ds[\"recharge\"][0], ds, ax=axes[1][1])"
+    "nlmod.plot.data_array(ds[\"recharge\"][0], ds, ax=axes[1][1]);"
    ]
   },
   {
@@ -324,7 +322,7 @@
     "x = np.mean(extent[:2])\n",
     "line = [(x, extent[2]), (x, extent[3])]\n",
     "\n",
-    "ds[\"heads\"] = nlmod.gwf.get_heads_da(ds)\n",
+    "head = nlmod.gwf.get_heads_da(ds)\n",
     "\n",
     "f, ax = plt.subplots(figsize=(10, 6))\n",
     "dcs = nlmod.plot.DatasetCrossSection(ds, line, ax=ax, zmin=-30.0, zmax=5.0)\n",
@@ -343,9 +341,9 @@
     "f.tight_layout(pad=0.0)\n",
     "\n",
     "anim = dcs.animate(\n",
-    "    ds[\"heads\"],\n",
+    "    head,\n",
     "    cmap=\"Spectral_r\",\n",
-    "    head=ds[\"heads\"],\n",
+    "    head=head,\n",
     "    plot_title=f\"doorsnede at x={int(x)}\",\n",
     "    date_fmt=\"%Y-%m-%d\",\n",
     ")\n",

docs/examples/10_modpath.ipynb

@@ -155,7 +155,7 @@
     "    ax.plot(pf[\"x\"], pf[\"y\"], color=\"k\", linewidth=0.5)\n",
     "ax.plot(pf[\"x\"], pf[\"y\"], color=\"k\", linewidth=0.5, label=\"pathline\")\n",
     "\n",
-    "cids = [nlmod.grid.xy_to_icell2d(xy, ds) for xy in xy_start]\n",
+    "cids = [nlmod.grid.get_icell2d_from_xy(xy[0], xy[1], ds) for xy in xy_start]\n",
     "ax.plot(\n",
     "    ds.x[cids],\n",
     "    ds.y[cids],\n",
@@ -256,7 +256,7 @@
     "        ax.plot(pf[\"x\"], pf[\"y\"], color=\"k\", linewidth=0.5)\n",
     "    ax.plot(pf[\"x\"], pf[\"y\"], color=\"k\", linewidth=0.5, label=\"pathline\")\n",
     "\n",
-    "    cids = [nlmod.grid.xy_to_icell2d(xy, ds) for xy in xy_start]\n",
+    "    cids = [nlmod.grid.get_icell2d_from_xy(xy[0], xy[1], ds) for xy in xy_start]\n",
     "    ax.plot(\n",
     "        ds.x[cids],\n",
     "        ds.y[cids],\n",

docs/examples/12_layer_generation.ipynb

@@ -71,7 +71,7 @@
    "outputs": [],
    "source": [
     "f, ax = nlmod.plot.get_map(extent, figsize=5)\n",
-    "nlmod.plot.data_array(regis[\"top\"], edgecolor=\"k\")"
+    "nlmod.plot.data_array(regis[\"top\"], edgecolor=\"k\");"
    ]
   },
   {
@@ -133,7 +133,7 @@
    "outputs": [],
    "source": [
     "f, ax = nlmod.plot.get_map(extent, figsize=5)\n",
-    "nlmod.plot.data_array(ds[\"top\"], ds=ds, edgecolor=\"k\")"
+    "nlmod.plot.data_array(ds[\"top\"], ds=ds, edgecolor=\"k\");"
    ]
   },
   {
@@ -173,7 +173,7 @@
    "outputs": [],
    "source": [
     "f, ax = nlmod.plot.get_map(extent, figsize=5)\n",
-    "nlmod.plot.data_array(ds[\"top\"], ds=ds, edgecolor=\"k\")"
+    "nlmod.plot.data_array(ds[\"top\"], ds=ds, edgecolor=\"k\");"
    ]
   }
  ],

docs/examples/13_plot_methods.ipynb

@@ -171,7 +171,9 @@
    "id": "fba12db0",
    "metadata": {},
    "source": [
-    "With the DatasetCrossSection in `nlmod` it is also possible to plot the layers according to the official colors of REGIS, to plot the layer names on the plot, or to plot the model grid in the cross-section. An example is shown in the plot below."
+    "With the DatasetCrossSection in `nlmod` it is also possible to plot the layers according to the official colors of REGIS, to plot the layer names on the plot, or to plot the model grid in the cross-section. An example is shown in the plot below.\n",
+    "\n",
+    "The location of the cross-section and the cross-section labels can be added using `nlmod.plot.inset_map()` and `nlmod.plot.add_xsec_line_and_labels()`."
    ]
   },
   {
@@ -185,7 +187,9 @@
     "dcs = DatasetCrossSection(ds, line=line, zmin=-200, zmax=10, ax=ax)\n",
     "colors = nlmod.read.regis.get_legend()\n",
     "dcs.plot_layers(colors=colors, min_label_area=1000)\n",
-    "dcs.plot_grid(vertical=False, linewidth=0.5);"
+    "dcs.plot_grid(vertical=False, linewidth=0.5)\n",
+    "mapax = nlmod.plot.inset_map(ax, ds.extent)\n",
+    "nlmod.plot.add_xsec_line_and_labels(line, ax, mapax)"
    ]
   },
   {
@@ -244,7 +248,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "df.plot(figsize=(10, 10))"
+    "df.plot(figsize=(10, 10));"
    ]
   }
  ],

docs/examples/15_geotop.ipynb

@@ -388,7 +388,7 @@
     "var = \"kh\"\n",
     "norm = matplotlib.colors.Normalize(0.0, 40.0)\n",
     "\n",
-    "f, axes = nlmod.plot.get_map(extent, nrows=2, figsize=(16, 8))\n",
+    "f, axes = nlmod.plot.get_map(extent, nrows=2)\n",
     "pc = nlmod.plot.data_array(regis[var].loc[layer], ax=axes[0], norm=norm)\n",
     "nlmod.plot.colorbar_inside(pc, bounds=[0.02, 0.05, 0.02, 0.9], ax=axes[0])\n",
     "nlmod.plot.title_inside(\"REGIS\", ax=axes[0])\n",

docs/examples/16_groundwater_transport.ipynb

@@ -173,6 +173,7 @@
     "vaklodingen = nlmod.read.jarkus.get_dataset_jarkus(\n",
     "    extent_hbossche,\n",
     "    kind=\"vaklodingen\",\n",
+    "    time=\"2020\",\n",
     "    cachedir=cachedir,\n",
     "    cachename=\"vaklodingen.nc\",\n",
     ")\n",