pastastore 1.8.0__py3-none-any.whl → 1.10.0__py3-none-any.whl

pastastore/plotting.py

@@ -42,6 +42,13 @@ class Plots:
         """
         self.pstore = pstore
 
+    def __repr__(self):
+        """Return string representation of Plots submodule."""
+        methods = "".join(
+            [f"\n - {meth}" for meth in dir(self) if not meth.startswith("_")]
+        )
+        return "Plotting submodule, available methods:" + methods
+
     def _timeseries(
         self,
         libname,
@@ -98,8 +105,7 @@ class Plots:
 
         if len(names) > 20 and split:
             raise ValueError(
-                "More than 20 time series leads to too many "
-                "subplots, set split=False."
+                "More than 20 time series leads to too many subplots, set split=False."
             )
 
         if ax is None:
@@ -478,6 +484,7 @@ class Plots:
         figsize=(6, 6),
         label=None,
         legend=True,
+        progressbar=True,
     ):
         """Plot a cumulative step histogram for a model statistic.
 
@@ -501,6 +508,8 @@ class Plots:
             of models
         legend: bool, optional
             show legend, by default True
+        progressbar: bool, optional
+            show progressbar, default is True.
 
         Returns
         -------
@@ -508,7 +517,7 @@ class Plots:
             The axes in which the cumulative histogram is plotted
         """
         statsdf = self.pstore.get_statistics(
-            [statistic], modelnames=modelnames, progressbar=False
+            [statistic], modelnames=modelnames, progressbar=progressbar
         )
 
         if ax is None:
@@ -542,7 +551,7 @@ class Plots:
 
         if label is None:
             if extend:
-                label = f"No. Models = {len(statsdf)-1}"
+                label = f"No. Models = {len(statsdf) - 1}"
             else:
                 label = f"No. Models = {len(statsdf)}"
 
@@ -580,15 +589,15 @@ class Plots:
             The CompareModels object containing the comparison results.
         """
         models = self.pstore.get_models(modelnames)
-        names = []
+        names = kwargs.pop("names", [])
         onames = [iml.oseries.name for iml in models]
-        if len(np.unique(onames)) == 1:
+        if len(np.unique(onames)) == 1 and len(names) == 0:
             for modelname in modelnames:
                 if onames[0] in modelname:
                     names.append(modelname.replace(onames[0], ""))
                 else:
                     names.append(modelname)
-        else:
+        elif len(np.unique(onames)) > 1:
             names = modelnames
         cm = ps.CompareModels(models, names=names)
         cm.plot(**kwargs)
@@ -618,6 +627,13 @@ class Maps:
         """
         self.pstore = pstore
 
+    def __repr__(self):
+        """Return string representation of Maps submodule."""
+        methods = "".join(
+            [f"\n - {meth}" for meth in dir(self) if not meth.startswith("_")]
+        )
+        return "Mapping submodule, available methods:" + methods
+
     def stresses(
         self,
         names=None,
@@ -628,6 +644,7 @@ class Maps:
         figsize=(10, 8),
         backgroundmap=False,
         label_kwargs=None,
+        show_legend: bool = True,
         **kwargs,
     ):
         """Plot stresses locations on map.
@@ -654,6 +671,9 @@ class Maps:
             by OpenStreetMap.Mapnik. Default option is False.
         label_kwargs: dict, optional
             dictionary with keyword arguments to pass to add_labels method
+        show_legend : bool, optional
+            add legend with each kind of stress and associated color, only possible
+            if colors are not explicitly passed. Default is True.
 
         Returns
         -------
@@ -680,7 +700,8 @@ class Maps:
         mask0 = (stresses["x"] != 0.0) | (stresses["y"] != 0.0)
 
         if "c" in kwargs:
-            c = kwargs.pop("c", None)
+            c = kwargs.pop("c")
+            kind_to_color = None
         else:
             c = stresses.loc[mask0, "kind"]
             kind_to_color = {k: f"C{i}" for i, k in enumerate(c.unique())}
@@ -688,7 +709,7 @@ class Maps:
 
         r = self._plotmap_dataframe(stresses.loc[mask0], c=c, figsize=figsize, **kwargs)
         if "ax" in kwargs:
-            ax = kwargs["ax"]
+            ax = kwargs.pop("ax")
         else:
             ax = r
         if labels:
@@ -696,6 +717,11 @@ class Maps:
                 label_kwargs = {}
             self.add_labels(stresses, ax, adjust=adjust, **label_kwargs)
 
+        if show_legend and kind_to_color is not None:
+            for k, color in kind_to_color.items():
+                ax.plot([], [], color=color, label=k, **kwargs, marker="o", ls="none")
+            ax.legend(loc=(0, 1), frameon=False, ncol=5)
+
         if backgroundmap:
             self.add_background_map(ax)
 
@@ -816,6 +842,81 @@ class Maps:
 
         return ax
 
+    def _map_helper(
+        self,
+        df,
+        column,
+        label=True,
+        adjust=False,
+        cmap="viridis",
+        norm=None,
+        vmin=None,
+        vmax=None,
+        figsize=(10, 8),
+        backgroundmap=False,
+        **kwargs,
+    ):
+        """Help function for plotting values on map.
+
+        Parameters
+        ----------
+        df: pd.DataFrame
+            dataframe containing plotting information
+        column: str
+            column with values to plot
+        label: bool, optional
+            label points, by default True
+        adjust: bool, optional
+            automated smart label placement using adjustText, by default False
+        cmap: str or colormap, optional
+            (name of) the colormap, by default "viridis"
+        norm: norm, optional
+            normalization for colorbar, by default None
+        vmin: float, optional
+            vmin for colorbar, by default None
+        vmax: float, optional
+            vmax for colorbar, by default None
+        ax : matplotlib.Axes, optional
+            axes handle, if not provided a new figure is created.
+        figsize: tuple, optional
+            figuresize, by default(10, 8)
+        backgroundmap: bool, optional
+            if True, add background map (default CRS is EPSG:28992) with default tiles
+            by OpenStreetMap.Mapnik. Default option is False.
+        progressbar: bool, optional
+            show progressbar, default is True.
+
+        Returns
+        -------
+        ax: matplotlib.Axes
+            axes object
+
+        See Also
+        --------
+        self.add_background_map
+        """
+        scatter_kwargs = {
+            "cmap": cmap,
+            "norm": norm,
+            "vmin": vmin,
+            "vmax": vmax,
+            "edgecolors": "w",
+            "linewidths": 0.7,
+        }
+        scatter_kwargs.update(kwargs)
+
+        ax = self._plotmap_dataframe(
+            df, column=column, figsize=figsize, **scatter_kwargs
+        )
+        if label:
+            df.set_index("index", inplace=True)
+            self.add_labels(df, ax, adjust=adjust)
+
+        if backgroundmap:
+            self.add_background_map(ax)
+
+        return ax
+
     def modelstat(
         self,
         statistic,
@@ -828,6 +929,7 @@ class Maps:
         vmax=None,
         figsize=(10, 8),
         backgroundmap=False,
+        progressbar=True,
         **kwargs,
     ):
         """Plot model statistic on map.
@@ -857,6 +959,8 @@ class Maps:
         backgroundmap: bool, optional
             if True, add background map (default CRS is EPSG:28992) with default tiles
             by OpenStreetMap.Mapnik. Default option is False.
+        progressbar: bool, optional
+            show progressbar, default is True.
 
         Returns
         -------
@@ -868,7 +972,7 @@ class Maps:
         self.add_background_map
         """
         statsdf = self.pstore.get_statistics(
-            [statistic], modelnames=modelnames, progressbar=False
+            [statistic], modelnames=modelnames, progressbar=progressbar
         ).to_frame()
 
         statsdf["oseries"] = [
@@ -878,28 +982,177 @@ class Maps:
         statsdf = statsdf.reset_index().set_index("oseries")
         df = statsdf.join(self.pstore.oseries, how="left")
 
-        scatter_kwargs = {
-            "cmap": cmap,
-            "norm": norm,
-            "vmin": vmin,
-            "vmax": vmax,
-            "edgecolors": "w",
-            "linewidths": 0.7,
-        }
+        return self._map_helper(
+            df,
+            column=statistic,
+            label=label,
+            adjust=adjust,
+            cmap=cmap,
+            norm=norm,
+            vmin=vmin,
+            vmax=vmax,
+            figsize=figsize,
+            backgroundmap=backgroundmap,
+            **kwargs,
+        )
 
-        scatter_kwargs.update(kwargs)
+    def modelparam(
+        self,
+        parameter,
+        modelnames=None,
+        label=True,
+        adjust=False,
+        cmap="viridis",
+        norm=None,
+        vmin=None,
+        vmax=None,
+        figsize=(10, 8),
+        backgroundmap=False,
+        progressbar=True,
+        **kwargs,
+    ):
+        """Plot model parameter value on map.
 
-        ax = self._plotmap_dataframe(
-            df, column=statistic, figsize=figsize, **scatter_kwargs
+        Parameters
+        ----------
+        parameter: str
+            name of the parameter, e.g. "rech_A" or "river_a"
+        modelnames : list of str, optional
+            list of modelnames to include
+        label: bool, optional
+            label points, by default True
+        adjust: bool, optional
+            automated smart label placement using adjustText, by default False
+        cmap: str or colormap, optional
+            (name of) the colormap, by default "viridis"
+        norm: norm, optional
+            normalization for colorbar, by default None
+        vmin: float, optional
+            vmin for colorbar, by default None
+        vmax: float, optional
+            vmax for colorbar, by default None
+        ax : matplotlib.Axes, optional
+            axes handle, if not provided a new figure is created.
+        figsize: tuple, optional
+            figuresize, by default(10, 8)
+        backgroundmap: bool, optional
+            if True, add background map (default CRS is EPSG:28992) with default tiles
+            by OpenStreetMap.Mapnik. Default option is False.
+        progressbar: bool, optional
+            show progressbar, default is True
+
+        Returns
+        -------
+        ax: matplotlib.Axes
+            axes object
+
+        See Also
+        --------
+        self.add_background_map
+        """
+        paramdf = self.pstore.get_parameters(
+            [parameter],
+            modelnames=modelnames,
+            progressbar=progressbar,
+            ignore_errors=True,
+        ).to_frame()
+
+        paramdf["oseries"] = [
+            self.pstore.get_models(m, return_dict=True)["oseries"]["name"]
+            for m in paramdf.index
+        ]
+        paramdf = paramdf.reset_index().set_index("oseries")
+        df = paramdf.join(self.pstore.oseries, how="left")
+
+        return self._map_helper(
+            df,
+            column=parameter,
+            label=label,
+            adjust=adjust,
+            cmap=cmap,
+            norm=norm,
+            vmin=vmin,
+            vmax=vmax,
+            figsize=figsize,
+            backgroundmap=backgroundmap,
+            **kwargs,
         )
-        if label:
-            df.set_index("index", inplace=True)
-            self.add_labels(df, ax, adjust=adjust)
 
-        if backgroundmap:
-            self.add_background_map(ax)
+    def signature(
+        self,
+        signature,
+        names=None,
+        label=True,
+        adjust=False,
+        cmap="viridis",
+        norm=None,
+        vmin=None,
+        vmax=None,
+        figsize=(10, 8),
+        backgroundmap=False,
+        progressbar=True,
+        **kwargs,
+    ):
+        """Plot signature value on map.
 
-        return ax
+        Parameters
+        ----------
+        signature: str
+            name of the signature, e.g. "mean_annual_maximum" or "duration_curve_slope"
+        names : list of str, optional
+            list of observation well names to include
+        label: bool, optional
+            label points, by default True
+        adjust: bool, optional
+            automated smart label placement using adjustText, by default False
+        cmap: str or colormap, optional
+            (name of) the colormap, by default "viridis"
+        norm: norm, optional
+            normalization for colorbar, by default None
+        vmin: float, optional
+            vmin for colorbar, by default None
+        vmax: float, optional
+            vmax for colorbar, by default None
+        ax : matplotlib.Axes, optional
+            axes handle, if not provided a new figure is created.
+        figsize: tuple, optional
+            figuresize, by default(10, 8)
+        backgroundmap: bool, optional
+            if True, add background map (default CRS is EPSG:28992) with default tiles
+            by OpenStreetMap.Mapnik. Default option is False.
+        progressbar: bool, optional
+            show progressbar, default is True
+
+        Returns
+        -------
+        ax: matplotlib.Axes
+            axes object
+
+        See Also
+        --------
+        self.add_background_map
+        """
+        signature_df = self.pstore.get_signatures(
+            [signature],
+            names=names,
+            progressbar=progressbar,
+            ignore_errors=True,
+        )
+        df = signature_df.join(self.pstore.oseries, how="left")
+
+        return self._map_helper(
+            df,
+            column=signature,
+            label=label,
+            adjust=adjust,
+            cmap=cmap,
+            norm=norm,
+            vmin=vmin,
+            vmax=vmax,
+            figsize=figsize,
+            backgroundmap=backgroundmap,
+            **kwargs,
+        )
 
     @staticmethod
     def _plotmap_dataframe(
@@ -949,6 +1202,7 @@ class Maps:
         if ax is None:
             return_scatter = False
             fig, ax = plt.subplots(figsize=figsize)
+            ax.set_aspect("equal", adjustable="box")
         else:
             return_scatter = True
             fig = ax.figure
@@ -1011,8 +1265,8 @@ class Maps:
         label: bool, optional, default is True
             add labels to points on map
         metadata_source: str, optional
-            whether to obtain metadata from model Timeseries or from
-            metadata in pastastore("store"), default is "model"
+            one of "model" or "store", pick whether to obtain metadata from model
+            Timeseries or from metadata in pastastore, default is "model"
         offset : float, optional
             add offset to current extent of model time series, useful
             for zooming out around models
@@ -1053,7 +1307,7 @@ class Maps:
                     yi = imeta.pop("y", np.nan)
                 else:
                     raise ValueError(
-                        "metadata_source must be either " "'model' or 'store'!"
+                        "metadata_source must be either 'model' or 'store'!"
                     )
                 if np.isnan(xi) or np.isnan(yi):
                     print(f"No x,y-data for {istress.name}!")
@@ -1062,7 +1316,7 @@ class Maps:
                     print(f"x,y-data is 0.0 for {istress.name}, not plotting!")
                     continue
 
-                stresses.loc[istress.name, :] = (xi, yi, name, f"C{count%10}")
+                stresses.loc[istress.name, :] = (xi, yi, name, f"C{count % 10}")
             count += 1
 
         # create figure
@@ -1083,7 +1337,7 @@ class Maps:
             xm = float(ometa.pop("x", np.nan))
             ym = float(ometa.pop("y", np.nan))
         else:
-            raise ValueError("metadata_source must be either " "'model' or 'store'!")
+            raise ValueError("metadata_source must be either 'model' or 'store'!")
 
         po = ax.scatter(xm, ym, s=osize, marker="o", label=oserieslabel, color="k")
         legend_list = [po]
@@ -1250,14 +1504,14 @@ class Maps:
                 if np.isin(st.loc[s, "kind"], kinds):
                     (c,) = np.where(skind == st.loc[s, "kind"])
                     if color_lines:
-                        color = f"C{c[0]+1}"
+                        color = f"C{c[0] + 1}"
                     else:
                         color = "k"
                     segments.append(
                         [[os["x"], os["y"]], [st.loc[s, "x"], st.loc[s, "y"]]]
                     )
                     segment_colors.append(color)
-                    scatter_colors.append(f"C{c[0]+1}")
+                    scatter_colors.append(f"C{c[0] + 1}")
 
                     stused = np.append(stused, s)
 
@@ -1294,7 +1548,7 @@ class Maps:
                         [],
                         marker="o",
                         color="w",
-                        markerfacecolor=f"C{c[0]+1}",
+                        markerfacecolor=f"C{c[0] + 1}",
                         label=kind,
                         markersize=10,
                     )