pastastore 1.3.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

pastastore/__init__.py

@@ -1,5 +1,5 @@
 # ruff: noqa: F401
-from pastastore import connectors, util
+from pastastore import connectors, styling, util
 from pastastore.connectors import (
     ArcticConnector,
     ArcticDBConnector,

pastastore/plotting.py

@@ -14,6 +14,7 @@ follows::
     ax = pstore.maps.oseries()
     pstore.maps.add_background_map(ax)  # for adding a background map
 """
+
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
@@ -49,6 +50,9 @@ class Plots:
         split=False,
         figsize=(10, 5),
         progressbar=True,
+        show_legend=True,
+        labelfunc=None,
+        legend_kwargs=None,
         **kwargs,
     ):
         """Internal method to plot time series from pastastore.
@@ -71,6 +75,13 @@ class Plots:
         progressbar : bool, optional
             show progressbar when loading time series from store,
             by default True
+        show_legend : bool, optional
+            show legend, default is True.
+        labelfunc : callable, optional
+            function to create custom labels, function should take name of time series
+            as input
+        legend_kwargs : dict, optional
+            additional arguments to pass to legend
 
         Returns
         -------
@@ -109,16 +120,33 @@ class Plots:
                 iax = axes
             else:
                 iax = ax
+            if labelfunc is not None:
+                n = labelfunc(n)
             iax.plot(ts.index, ts.squeeze(), label=n, **kwargs)
-            if split:
+
+            if split and show_legend:
                 iax.legend(loc="best", fontsize="x-small")
 
-        if not split:
-            axes.legend(loc=(0, 1), frameon=False, ncol=7, fontsize="x-small")
+        if not split and show_legend:
+            if legend_kwargs is None:
+                legend_kwargs = {}
+            ncol = legend_kwargs.pop("ncol", 7)
+            fontsize = legend_kwargs.pop("fontsize", "x-small")
+            axes.legend(loc=(0, 1), frameon=False, ncol=ncol, fontsize=fontsize)
 
         return axes
 
-    def oseries(self, names=None, ax=None, split=False, figsize=(10, 5), **kwargs):
+    def oseries(
+        self,
+        names=None,
+        ax=None,
+        split=False,
+        figsize=(10, 5),
+        show_legend=True,
+        labelfunc=None,
+        legend_kwargs=None,
+        **kwargs,
+    ):
         """Plot oseries.
 
         Parameters
@@ -134,6 +162,13 @@ class Plots:
             A maximum of 20 time series is supported when split=True.
         figsize : tuple, optional
             figure size, by default (10, 5)
+        show_legend : bool, optional
+            show legend, default is True.
+        labelfunc : callable, optional
+            function to create custom labels, function should take name of time series
+            as input
+        legend_kwargs : dict, optional
+            additional arguments to pass to legend
 
         Returns
         -------
@@ -146,6 +181,9 @@ class Plots:
             ax=ax,
             split=split,
             figsize=figsize,
+            show_legend=show_legend,
+            labelfunc=labelfunc,
+            legend_kwargs=legend_kwargs,
             **kwargs,
         )
 
@@ -156,6 +194,9 @@ class Plots:
         ax=None,
         split=False,
         figsize=(10, 5),
+        show_legend=True,
+        labelfunc=None,
+        legend_kwargs=None,
         **kwargs,
     ):
         """Plot stresses.
@@ -176,6 +217,13 @@ class Plots:
             A maximum of 20 time series is supported when split=True.
         figsize : tuple, optional
             figure size, by default (10, 5)
+        show_legend : bool, optional
+            show legend, default is True.
+        labelfunc : callable, optional
+            function to create custom labels, function should take name of time series
+            as input
+        legend_kwargs : dict, optional
+            additional arguments to pass to legend
 
         Returns
         -------
@@ -196,6 +244,9 @@ class Plots:
             ax=ax,
             split=split,
             figsize=figsize,
+            show_legend=show_legend,
+            labelfunc=labelfunc,
+            legend_kwargs=legend_kwargs,
             **kwargs,
         )
 
@@ -511,6 +562,22 @@ class Plots:
 
         return ax
 
+    def compare_models(self, modelnames, ax=None, **kwargs):
+        models = self.pstore.get_models(modelnames)
+        names = []
+        onames = [iml.oseries.name for iml in models]
+        if len(np.unique(onames)) == 1:
+            for modelname in modelnames:
+                if onames[0] in modelname:
+                    names.append(modelname.replace(onames[0], ""))
+                else:
+                    names.append(modelname)
+        else:
+            names = modelnames
+        cm = ps.CompareModels(models, names=names)
+        cm.plot(**kwargs)
+        return cm
+
 
 class Maps:
     """Map Class for PastaStore.
@@ -539,10 +606,12 @@ class Maps:
         self,
         names=None,
         kind=None,
+        extent=None,
         labels=True,
         adjust=False,
         figsize=(10, 8),
         backgroundmap=False,
+        label_kwargs=None,
         **kwargs,
     ):
         """Plot stresses locations on map.
@@ -554,6 +623,8 @@ class Maps:
         kind: str, optional
             if passed, only plot stresses of a specific kind, default is None
             which plots all stresses.
+        extent : list of float, optional
+            plot only stresses within extent [xmin, xmax, ymin, ymax]
         labels: bool, optional
             label models, by default True
         adjust: bool, optional
@@ -565,6 +636,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.
+        label_kwargs: dict, optional
+            dictionary with keyword arguments to pass to add_labels method
 
         Returns
         -------
@@ -575,10 +648,10 @@ class Maps:
         --------
         self.add_background_map
         """
-        if names is not None:
-            df = self.pstore.stresses.loc[names]
-        else:
-            df = self.pstore.stresses
+        names = self.pstore.conn._parse_names(names, "stresses")
+        if extent is not None:
+            names = self.pstore.within(extent, names=names, libname="stresses")
+        df = self.pstore.stresses.loc[names]
 
         if kind is not None:
             if isinstance(kind, str):
@@ -603,7 +676,9 @@ class Maps:
         else:
             ax = r
         if labels:
-            self.add_labels(stresses, ax, adjust=adjust)
+            if label_kwargs is None:
+                label_kwargs = {}
+            self.add_labels(stresses, ax, adjust=adjust, **label_kwargs)
 
         if backgroundmap:
             self.add_background_map(ax)
@@ -613,10 +688,12 @@ class Maps:
     def oseries(
         self,
         names=None,
+        extent=None,
         labels=True,
         adjust=False,
         figsize=(10, 8),
         backgroundmap=False,
+        label_kwargs=None,
         **kwargs,
     ):
         """Plot oseries locations on map.
@@ -625,8 +702,11 @@ class Maps:
         ----------
         names: list, optional
             oseries names, by default None which plots all oseries locations
-        labels: bool, optional
-            label models, by default True
+        extent : list of float, optional
+            plot only oseries within extent [xmin, xmax, ymin, ymax]
+        labels: bool or str, optional
+            label models, by default True, if passed as "grouped", only the first
+            label for each x,y-location is shown.
         adjust: bool, optional
             automated smart label placement using adjustText, by default False
         figsize: tuple, optional
@@ -634,6 +714,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.
+        label_kwargs: dict, optional
+            dictionary with keyword arguments to pass to add_labels method
 
         Returns
         -------
@@ -646,6 +728,8 @@ class Maps:
         """
 
         names = self.pstore.conn._parse_names(names, "oseries")
+        if extent is not None:
+            names = self.pstore.within(extent, names=names)
         oseries = self.pstore.oseries.loc[names]
         mask0 = (oseries["x"] != 0.0) | (oseries["y"] != 0.0)
         r = self._plotmap_dataframe(oseries.loc[mask0], figsize=figsize, **kwargs)
@@ -654,7 +738,12 @@ class Maps:
         else:
             ax = r
         if labels:
-            self.add_labels(oseries, ax, adjust=adjust)
+            if label_kwargs is None:
+                label_kwargs = {}
+            if labels == "grouped":
+                gr = oseries.sort_index().reset_index().groupby(["x", "y"])
+                oseries = oseries.loc[gr["index"].first().tolist()]
+            self.add_labels(oseries, ax, adjust=adjust, **label_kwargs)
 
         if backgroundmap:
             self.add_background_map(ax)
@@ -1258,7 +1347,7 @@ class Maps:
         ctx.add_basemap(ax, source=providers[map_provider], crs=proj.srs, **kwargs)
 
     @staticmethod
-    def add_labels(df, ax, adjust=False, **kwargs):
+    def add_labels(df, ax, adjust=False, objects=None, **kwargs):
         """Add labels to points on plot.
 
         Uses dataframe index to label points.
@@ -1271,11 +1360,12 @@ class Maps:
             axes object to label points on
         adjust: bool
             automated smart label placement using adjustText
+        objects : list of matplotlib objects
+            use to avoid labels overlapping markers
         **kwargs:
-            keyword arguments to ax.annotate
+            keyword arguments to ax.annotate or adjusttext
         """
         stroke = [patheffects.withStroke(linewidth=3, foreground="w")]
-
         fontsize = kwargs.pop("fontsize", 10)
 
         if adjust:
@@ -1295,7 +1385,9 @@ class Maps:
 
             adjust_text(
                 texts,
-                force_text=0.05,
+                objects=objects,
+                force_text=(0.05, 0.10),
+                **kwargs,
                 **{
                     "arrowprops": {
                         "arrowstyle": "-",
@@ -1318,4 +1410,5 @@ class Maps:
                     textcoords=textcoords,
                     xytext=xytext,
                     **{"path_effects": stroke},
+                    **kwargs,
                 )

pastastore/store.py

@@ -380,7 +380,7 @@ class PastaStore:
                         i_signatures.append(sign_val)
                 else:
                     raise e
-            signatures_df.loc[name, signatures] = i_signatures
+            signatures_df.loc[name, signatures] = i_signatures.squeeze()
 
         return signatures_df
 
@@ -991,8 +991,9 @@ class PastaStore:
         libname: str,
         s: Optional[Union[list, str]] = None,
         case_sensitive: bool = True,
+        sort=True,
     ):
-        """Search for names of time series or models starting with s.
+        """Search for names of time series or models starting with `s`.
 
         Parameters
         ----------
@@ -1002,6 +1003,8 @@ class PastaStore:
             find names with part of this string or strings in list
         case_sensitive : bool, optional
             whether search should be case sensitive, by default True
+        sort : bool, optional
+            sort list of names
 
         Returns
         -------
@@ -1031,7 +1034,8 @@ class PastaStore:
                 else:
                     m = np.append(m, [n for n in lib_names if sub.lower() in n.lower()])
             matches = list(np.unique(m))
-
+        if sort:
+            matches.sort()
         return matches
 
     def get_model_timeseries_names(
@@ -1127,6 +1131,36 @@ class PastaStore:
                 "'libname' must be one of ['oseries', 'stresses', 'models']!"
             )
         getter = getattr(self.conn, f"get_{libname}")
-        for n in tqdm(names) if progressbar else names:
+        for n in (
+            tqdm(names, desc=f"Applying {func.__name__}") if progressbar else names
+        ):
             result[n] = func(getter(n))
         return result
+
+    def within(self, extent, names=None, libname="oseries"):
+        xmin, xmax, ymin, ymax = extent
+        names = self.conn._parse_names(names, libname)
+        if libname == "oseries":
+            df = self.oseries.loc[names]
+        elif libname == "stresses":
+            df = self.stresses.loc[names]
+        elif libname == "models":
+            onames = np.unique(
+                [
+                    self.get_models(modelname, return_dict=True)["oseries"]["name"]
+                    for modelname in names
+                ]
+            )
+            df = self.oseries.loc[onames]
+        else:
+            raise ValueError(
+                "libname must be one of ['oseries', 'stresses', 'models']"
+                f", got '{libname}'"
+            )
+        mask = (
+            (df["x"] <= xmax)
+            & (df["x"] >= xmin)
+            & (df["y"] >= ymin)
+            & (df["y"] <= ymax)
+        )
+        return df.loc[mask].index.tolist()

pastastore/styling.py

@@ -0,0 +1,66 @@
+import matplotlib as mpl
+import matplotlib.pyplot as plt
+import numpy as np
+
+
+def float_styler(val, norm, cmap=None):
+    """Style float values in DataFrame.
+
+    Parameters
+    ----------
+    val : float
+        value in cell
+    norm : matplotlib.colors.Normalize
+        normalizer to map values to range(0, 1)
+    cmap : colormap, optional
+        colormap to use, by default None, which uses RdYlBu
+
+    Returns
+    -------
+    str
+        css value pairs for styling dataframe
+
+    Usage
+    -----
+    Given some dataframe
+
+    >>> df.map(float_styler, subset=["some column"], norm=norm, cmap=cmap)
+
+    """
+    if cmap is None:
+        cmap = plt.get_cmap("RdYlBu")
+    bg = cmap(norm(val))
+    color = mpl.colors.rgb2hex(bg)
+    c = "White" if np.mean(bg[:3]) < 0.4 else "Black"
+    return f"background-color: {color}; color: {c}"
+
+
+def boolean_styler(b):
+    """Style boolean values in DataFrame.
+
+    Parameters
+    ----------
+    b : bool
+        value in cell
+
+    Returns
+    -------
+    str
+        css value pairs for styling dataframe
+
+    Usage
+    -----
+    Given some dataframe
+
+    >>> df.map(boolean_styler, subset=["some column"])
+    """
+    if b:
+        return (
+            f"background-color: {mpl.colors.rgb2hex((231/255, 255/255, 239/255))}; "
+            "color: darkgreen"
+        )
+    else:
+        return (
+            f"background-color: {mpl.colors.rgb2hex((255/255, 238/255, 238/255))}; "
+            "color: darkred"
+        )

pastastore/util.py

@@ -335,9 +335,11 @@ def compare_models(ml1, ml2, stats=None, detailed_comparison=False):
             try:
                 assert_series_equal(
                     oso,
-                    ml.oseries.series_original
-                    if PASTAS_LEQ_022
-                    else ml.oseries._series_original,
+                    (
+                        ml.oseries.series_original
+                        if PASTAS_LEQ_022
+                        else ml.oseries._series_original
+                    ),
                 )
                 compare_oso = True
             except (ValueError, AssertionError):
@@ -378,9 +380,9 @@ def compare_models(ml1, ml2, stats=None, detailed_comparison=False):
             for ts in stresses:
                 df.loc[f"- time series: '{ts.name}'"] = ts.name
                 for tsk in ts.settings.keys():
-                    df.loc[
-                        f"  - {ts.name} settings: {tsk}", f"model {i}"
-                    ] = ts.settings[tsk]
+                    df.loc[f"  - {ts.name} settings: {tsk}", f"model {i}"] = (
+                        ts.settings[tsk]
+                    )
 
                 if i == 0:
                     if PASTAS_LEQ_022:
@@ -403,9 +405,11 @@ def compare_models(ml1, ml2, stats=None, detailed_comparison=False):
                     try:
                         assert_series_equal(
                             so1[counter],
-                            ts.series_original
-                            if PASTAS_LEQ_022
-                            else ts._series_original,
+                            (
+                                ts.series_original
+                                if PASTAS_LEQ_022
+                                else ts._series_original
+                            ),
                         )
                         compare_so1 = True
                     except (ValueError, AssertionError):
@@ -703,7 +707,7 @@ def frontiers_checks(
                             check_tmem_passed,
                         )
                 else:
-                    tmem = ml.get_response_tmax(sm_name)
+                    tmem = ml.get_response_tmax(sm_name, cutoff=check3_cutoff)
                     if tmem is None:  # no rfunc in stressmodel
                         tmem = 0
                     check_tmem_passed = tmem < len_oseries_calib / 2

pastastore/version.py

@@ -4,4 +4,4 @@ from packaging.version import parse as parse_version
 PASTAS_VERSION = parse_version(ps.__version__)
 PASTAS_LEQ_022 = PASTAS_VERSION <= parse_version("0.22.0")
 
-__version__ = "1.3.0"
+__version__ = "1.4.0"

{pastastore-1.3.0.dist-info → pastastore-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pastastore
-Version: 1.3.0
+Version: 1.4.0
 Summary: Tools for managing Pastas time series models.
 Author: D.A. Brakenhoff
 Maintainer-email: "D.A. Brakenhoff" <d.brakenhoff@artesia-water.nl>, "R. Calje" <r.calje@artesia-water.nl>, "M.A. Vonk" <m.vonk@artesia-water.nl>
@@ -57,6 +57,7 @@ Provides-Extra: arctic
 Requires-Dist: arctic ; extra == 'arctic'
 Provides-Extra: arcticdb
 Requires-Dist: arcticdb ; extra == 'arcticdb'
+Requires-Dist: protobuf ~=4.0 ; extra == 'arcticdb'
 Provides-Extra: docs
 Requires-Dist: pastastore[optional] ; extra == 'docs'
 Requires-Dist: sphinx-rtd-theme ; extra == 'docs'

pastastore-1.4.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+pastastore/__init__.py,sha256=LmaXFyfECBeaUeAEGeYxX-SU8g7tFUJ2ojyXoj3xz4o,292
+pastastore/base.py,sha256=nPIIiDHJMDUlvPaE2dftjPRxAM2kFtC8kHXvmB9Ayw0,62631
+pastastore/connectors.py,sha256=QH6jvnhIIivn1Is9ThBeMAEcJBVnfcK46pJClGMdiBA,28747
+pastastore/datasets.py,sha256=f-92WOh2ROCxOVvKGHXjnzd66Q7hO_-BtXRfMKwg1KU,6640
+pastastore/plotting.py,sha256=DCtbl81t23Zrk5l7QqxJVwv8wqvinBqlPbaTy5Q81sg,45849
+pastastore/store.py,sha256=9gjB5vq8XhfpProUjox_YKUssHvgQYAMMIf8epnAghA,40682
+pastastore/styling.py,sha256=u2rRf1Gqq5vs2HG7E4S4wEkEczyTuvCQaoYcvrh91lk,1465
+pastastore/util.py,sha256=CuQsLE3Z7egnel55LejVLXmOswwabGJiQtm164K7gxE,30830
+pastastore/version.py,sha256=hBqb0IH800rddVduM2_nP9zwh8BNg2nMxgX4FHGuiQQ,203
+pastastore/yaml_interface.py,sha256=yNpyEHtIapx44Thv2PCm7Sc_W-reXDHjT3uRC2gDAzw,29515
+pastastore-1.4.0.dist-info/LICENSE,sha256=DtHftfUEm99KzgwLr3rQUTg8H3kAS0Z-p5WWJgLf_OY,1082
+pastastore-1.4.0.dist-info/METADATA,sha256=6ZcnAKj_NUmsvdWFpU5qsNVFO7LghNPc_PpeJhX-Ij8,7896
+pastastore-1.4.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pastastore-1.4.0.dist-info/top_level.txt,sha256=QKfonr1KJZN46MFsj8eGRBw9Mg-jO-HFvgE2orVX7Sk,11
+pastastore-1.4.0.dist-info/RECORD,,

{pastastore-1.3.0.dist-info → pastastore-1.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pastastore-1.3.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-pastastore/__init__.py,sha256=GZvAtp_p3y2bOlcuLG2-jSHrYd72bIMDdBA5Wcy-diU,283
-pastastore/base.py,sha256=nPIIiDHJMDUlvPaE2dftjPRxAM2kFtC8kHXvmB9Ayw0,62631
-pastastore/connectors.py,sha256=QH6jvnhIIivn1Is9ThBeMAEcJBVnfcK46pJClGMdiBA,28747
-pastastore/datasets.py,sha256=f-92WOh2ROCxOVvKGHXjnzd66Q7hO_-BtXRfMKwg1KU,6640
-pastastore/plotting.py,sha256=3WTnnOfFZlt4PEsqDzNLFzFOJBtDb0vmwx4ZzdZI_xo,42120
-pastastore/store.py,sha256=vIPnq-XYU-HstweWa4RSuNHotYLTBNVQjljt6SH9fWY,39529
-pastastore/util.py,sha256=aVIrAtfJPatH7BfASChzwHsoug1KDthcgHlEbxl1-uk,30678
-pastastore/version.py,sha256=JXttE_aGZnNgRq0bbXfNL4jCLuHlFt9gD0xf0G99owU,203
-pastastore/yaml_interface.py,sha256=yNpyEHtIapx44Thv2PCm7Sc_W-reXDHjT3uRC2gDAzw,29515
-pastastore-1.3.0.dist-info/LICENSE,sha256=DtHftfUEm99KzgwLr3rQUTg8H3kAS0Z-p5WWJgLf_OY,1082
-pastastore-1.3.0.dist-info/METADATA,sha256=gXxIFp2Ge_pHkDPc0qfuI2wiNQGUZUSOSMWavKWQ8Fo,7844
-pastastore-1.3.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-pastastore-1.3.0.dist-info/top_level.txt,sha256=QKfonr1KJZN46MFsj8eGRBw9Mg-jO-HFvgE2orVX7Sk,11
-pastastore-1.3.0.dist-info/RECORD,,