pastastore 1.8.0__tar.gz → 1.9.0__tar.gz

{pastastore-1.8.0 → pastastore-1.9.0}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 D.A. Brakenhoff
+Copyright (c) 2020-2025 D.A. Brakenhoff
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{pastastore-1.8.0 → pastastore-1.9.0}/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pastastore
-Version: 1.8.0
+Version: 1.9.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>
 License: The MIT License (MIT)
         
-        Copyright (c) 2020 D.A. Brakenhoff
+        Copyright (c) 2020-2025 D.A. Brakenhoff
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
@@ -40,13 +40,13 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Scientific/Engineering :: Hydrology
-Requires-Python: >=3.7
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pastas>=0.13
@@ -65,26 +65,17 @@ Provides-Extra: arcticdb
 Requires-Dist: arcticdb; extra == "arcticdb"
 Provides-Extra: lint
 Requires-Dist: ruff; extra == "lint"
+Provides-Extra: pytest
+Requires-Dist: coverage; extra == "pytest"
+Requires-Dist: codecov; extra == "pytest"
+Requires-Dist: pytest; extra == "pytest"
+Requires-Dist: pytest-cov; extra == "pytest"
+Requires-Dist: pytest-dependency; extra == "pytest"
+Requires-Dist: pytest-benchmark; extra == "pytest"
+Requires-Dist: codacy-coverage; extra == "pytest"
 Provides-Extra: test
-Requires-Dist: pastastore[arcticdb,lint,optional]; extra == "test"
+Requires-Dist: pastastore[arcticdb,lint,optional,pytest]; extra == "test"
 Requires-Dist: hydropandas[full]; extra == "test"
-Requires-Dist: coverage; extra == "test"
-Requires-Dist: codecov; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-dependency; extra == "test"
-Requires-Dist: pytest-benchmark; extra == "test"
-Requires-Dist: codacy-coverage; extra == "test"
-Provides-Extra: test-py312
-Requires-Dist: pastastore[lint,optional]; extra == "test-py312"
-Requires-Dist: hydropandas[full]; extra == "test-py312"
-Requires-Dist: coverage; extra == "test-py312"
-Requires-Dist: codecov; extra == "test-py312"
-Requires-Dist: pytest; extra == "test-py312"
-Requires-Dist: pytest-cov; extra == "test-py312"
-Requires-Dist: pytest-dependency; extra == "test-py312"
-Requires-Dist: pytest-benchmark; extra == "test-py312"
-Requires-Dist: codacy-coverage; extra == "test-py312"
 Provides-Extra: docs
 Requires-Dist: pastastore[optional]; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
@@ -102,7 +93,7 @@ Requires-Dist: nbsphinx_link; extra == "docs"
 # pastastore
 
 This module stores 
-[Pastas](https://pastas.readthedocs.io/en/latest/) time series and models in a
+[Pastas](https://pastas.readthedocs.io/latest/) time series and models in a
 database.
 
 Storing time series and models in a database allows the user to manage time
@@ -187,4 +178,4 @@ pstore.to_zip("my_backup.zip")
 ```
 
 For more elaborate examples, refer to the
-[Notebooks](https://pastastore.readthedocs.io/en/latest/examples.html#example-notebooks).
+[Notebooks](https://pastastore.readthedocs.io/latest/examples.html#example-notebooks).

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/base.py

@@ -332,7 +332,8 @@ class BaseConnector(ABC):
             self._clear_cache(libname)
         else:
             raise ItemInLibraryException(
-                f"Item with name '{name}' already" f" in '{libname}' library!"
+                f"Time series with name '{name}' already in '{libname}' library! "
+                "Use overwrite=True to replace existing time series."
             )
 
     def _update_series(
@@ -575,7 +576,8 @@ class BaseConnector(ABC):
             )
         else:
             raise ItemInLibraryException(
-                f"Model with name '{name}' " "already in 'models' library!"
+                f"Model with name '{name}' already in 'models' library! "
+                "Use overwrite=True to replace existing model."
             )
         self._clear_cache("_modelnames_cache")
         self._add_oseries_model_links(str(mldict["oseries"]["name"]), name)
@@ -1093,8 +1095,7 @@ class BaseConnector(ABC):
         """
         if prompt:
             ui = input(
-                f"Do you want to empty '{libname}'"
-                " library of all its contents? [y/N] "
+                f"Do you want to empty '{libname}' library of all its contents? [y/N] "
             )
             if ui.lower() != "y":
                 return
@@ -1115,7 +1116,7 @@ class BaseConnector(ABC):
             ):
                 self._del_item(libname, name)
             self._clear_cache(libname)
-            print(f"Emptied library {libname} in {self.name}: " f"{self.__class__}")
+            print(f"Emptied library {libname} in {self.name}: {self.__class__}")
 
     def _iter_series(self, libname: str, names: Optional[List[str]] = None):
         """Iterate over time series in library (internal method).
@@ -1365,10 +1366,36 @@ class BaseConnector(ABC):
 class ModelAccessor:
     """Object for managing access to stored models.
 
-    Provides dict-like access to models (i.e. PastaStore.models["model1"]), or allows
-    adding models to the PastaStore using dict-like assignment (i.e.
-    PastaStore.models["model1"] = ml), and it can serve as an iterator (i.e. [ml for ml
-    in pstore.models]).
+    The ModelAccessor object allows dictionary-like assignment and access to models.
+    In addition it provides some useful utilities for working with stored models
+    in the database.
+
+    Examples
+    --------
+    Get a model by name::
+
+    >>> model = pstore.models["my_model"]
+
+    Store a model in the database::
+
+    >>> pstore.models["my_model_v2"] = model
+
+    Get model metadata dataframe::
+
+    >>> pstore.models.metadata
+
+    Number of models::
+
+    >>> len(pstore.models)
+
+    Random model::
+
+    >>> model = pstore.models.random()
+
+    Iterate over stored models::
+
+    >>> for ml in pstore.models:
+    >>>     ml.solve()
     """
 
     def __init__(self, conn):
@@ -1382,8 +1409,11 @@ class ModelAccessor:
         self.conn = conn
 
     def __repr__(self):
-        """Representation of the object is a list of modelnames."""
-        return self.conn._modelnames_cache.__repr__()
+        """Representation contains the number of models and the list of model names."""
+        return (
+            f"<{self.__class__.__name__}> {len(self)} model(s): \n"
+            + self.conn._modelnames_cache.__repr__()
+        )
 
     def __getitem__(self, name: str):
         """Get model from store with model name as key.
@@ -1436,3 +1466,27 @@ class ModelAccessor:
         from random import choice
 
         return self.conn.get_models(choice(self.conn._modelnames_cache))
+
+    @property
+    def metadata(self):
+        """Dataframe with overview of models metadata."""
+        # NOTE: cannot be cached as this dataframe is not a property of the connector
+        # I'm not sure how to clear this cache when models are added/removed.
+        idx = pd.MultiIndex.from_tuples(
+            ((k, i) for k, v in self.conn.oseries_models.items() for i in v),
+            names=["oseries", "modelname"],
+        )
+        modeldf = pd.DataFrame(index=idx)
+        modeldf = modeldf.join(
+            self.conn.oseries, on=modeldf.index.get_level_values(0)
+        ).drop("key_0", axis=1)
+        modeldf["n_stressmodels"] = 0
+        for onam, mlnam in modeldf.index:
+            mldict = self.conn.get_models(mlnam, return_dict=True)
+            modeldf.loc[(onam, mlnam), "n_stressmodels"] = len(mldict["stressmodels"])
+            modeldf.loc[(onam, mlnam), "stressmodel_names"] = ",".join(
+                list(mldict["stressmodels"].keys())
+            )
+            for setting in mldict["settings"].keys():
+                modeldf.loc[(onam, mlnam), setting] = mldict["settings"][setting]
+        return modeldf

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/connectors.py

@@ -370,8 +370,7 @@ class ConnectorUtil:
             raise TypeError("Expected pastas.Model or dict!")
         if name not in self.oseries.index:
             msg = (
-                f"Cannot add model because oseries '{name}' "
-                "is not contained in store."
+                f"Cannot add model because oseries '{name}' is not contained in store."
             )
             raise LookupError(msg)
         # expensive check
@@ -764,6 +763,7 @@ class ArcticDBConnector(BaseConnector, ConnectorUtil):
         """
         try:
             import arcticdb
+
         except ModuleNotFoundError as e:
             print("Please install arcticdb with `pip install arcticdb`!")
             raise e
@@ -777,6 +777,9 @@ class ArcticDBConnector(BaseConnector, ConnectorUtil):
         # for older versions of PastaStore, if oseries_models library is empty
         # populate oseries - models database
         self._update_all_oseries_model_links()
+        # write pstore file to store database info that can be used to load pstore
+        if "lmdb" in self.uri:
+            self.write_pstore_config_file()
 
     def _initialize(self, verbose: bool = True) -> None:
         """Initialize the libraries (internal method)."""
@@ -792,6 +795,29 @@ class ArcticDBConnector(BaseConnector, ConnectorUtil):
                     )
             self.libs[libname] = self._get_library(libname)
 
+    def write_pstore_config_file(self, path: str = None) -> None:
+        """Write pstore configuration file to store database info."""
+        # NOTE: method is not private as theoretically an ArcticDB
+        # database could also be hosted in the cloud, in which case,
+        # writing this config in the folder holding the database
+        # is no longer possible. For those situations, the user can
+        # write this config file and specify the path it should be
+        # written to.
+        config = {
+            "connector_type": self.conn_type,
+            "name": self.name,
+            "uri": self.uri,
+        }
+        if path is None and "lmdb" in self.uri:
+            path = self.uri.split("://")[1]
+        elif path is None and "lmdb" not in self.uri:
+            raise ValueError("Please provide a path to write the pastastore file!")
+
+        with open(
+            os.path.join(path, f"{self.name}.pastastore"), "w", encoding="utf-8"
+        ) as f:
+            json.dump(config, f)
+
     def _library_name(self, libname: str) -> str:
         """Get full library name according to ArcticDB (internal method)."""
         return ".".join([self.name, libname])
@@ -1165,6 +1191,7 @@ class PasConnector(BaseConnector, ConnectorUtil):
             whether to print message when database is initialized, by default True
         """
         self.name = name
+        self.parentdir = path
         self.path = os.path.abspath(os.path.join(path, self.name))
         self.relpath = os.path.relpath(self.path)
         self._initialize(verbose=verbose)
@@ -1172,6 +1199,8 @@ class PasConnector(BaseConnector, ConnectorUtil):
         # for older versions of PastaStore, if oseries_models library is empty
         # populate oseries_models library
         self._update_all_oseries_model_links()
+        # write pstore file to store database info that can be used to load pstore
+        self._write_pstore_config_file()
 
     def _initialize(self, verbose: bool = True) -> None:
         """Initialize the libraries (internal method)."""
@@ -1189,6 +1218,18 @@ class PasConnector(BaseConnector, ConnectorUtil):
                     )
             setattr(self, f"lib_{val}", os.path.join(self.path, val))
 
+    def _write_pstore_config_file(self):
+        """Write pstore configuration file to store database info."""
+        config = {
+            "connector_type": self.conn_type,
+            "name": self.name,
+            "path": self.parentdir,
+        }
+        with open(
+            os.path.join(self.path, f"{self.name}.pastastore"), "w", encoding="utf-8"
+        ) as f:
+            json.dump(config, f)
+
     def _get_library(self, libname: str):
         """Get path to directory holding data.
 

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/extensions/hpd.py

@@ -259,7 +259,7 @@ class HydroPandasExtension:
         meteo_var: str = "RD",
         tmin: TimeType = None,
         tmax: TimeType = None,
-        unit_multiplier: float = 1e-3,
+        unit_multiplier: float = 1e3,
         fill_missing_obs: bool = True,
         normalize_datetime_index: bool = True,
         **kwargs,
@@ -298,7 +298,7 @@ class HydroPandasExtension:
         meteo_var: str = "EV24",
         tmin: TimeType = None,
         tmax: TimeType = None,
-        unit_multiplier: float = 1e-3,
+        unit_multiplier: float = 1e3,
         fill_missing_obs: bool = True,
         normalize_datetime_index: bool = True,
         **kwargs,
@@ -409,7 +409,7 @@ class HydroPandasExtension:
         meteo_var: str = "RD",
         tmin: Optional[TimeType] = None,
         tmax: Optional[TimeType] = None,
-        unit_multiplier: float = 1e-3,
+        unit_multiplier: float = 1e3,
         normalize_datetime_index: bool = True,
         fill_missing_obs: bool = True,
         **kwargs,
@@ -428,7 +428,7 @@ class HydroPandasExtension:
             end time
         unit_multiplier : float, optional
             multiply unit by this value before saving it in the store,
-            by default 1.0 (no conversion)
+            by default 1e3 (converting m to mm)
         fill_missing_obs : bool, optional
             if True, fill missing observations by getting observations from nearest
             station with data.
@@ -454,7 +454,7 @@ class HydroPandasExtension:
         meteo_var: str = "EV24",
         tmin: Optional[TimeType] = None,
         tmax: Optional[TimeType] = None,
-        unit_multiplier: float = 1e-3,
+        unit_multiplier: float = 1e3,
         normalize_datetime_index: bool = True,
         fill_missing_obs: bool = True,
         **kwargs,
@@ -474,7 +474,7 @@ class HydroPandasExtension:
             end time
         unit_multiplier : float, optional
             multiply unit by this value before saving it in the store,
-            by default 1.0 (no conversion)
+            by default 1e3 (converting m to mm)
         fill_missing_obs : bool, optional
             if True, fill missing observations by getting observations from nearest
             station with data.

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/plotting.py

@@ -98,8 +98,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:
@@ -542,7 +541,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)}"
 
@@ -1053,7 +1052,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 +1061,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 +1082,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 +1249,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 +1293,7 @@ class Maps:
                         [],
                         marker="o",
                         color="w",
-                        markerfacecolor=f"C{c[0]+1}",
+                        markerfacecolor=f"C{c[0] + 1}",
                         label=kind,
                         markersize=10,
                     )

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/store.py

@@ -15,7 +15,7 @@ from pastas.io.pas import pastas_hook
 from tqdm.auto import tqdm
 
 from pastastore.base import BaseConnector
-from pastastore.connectors import DictConnector
+from pastastore.connectors import ArcticDBConnector, DictConnector, PasConnector
 from pastastore.plotting import Maps, Plots
 from pastastore.util import _custom_warning
 from pastastore.version import PASTAS_GEQ_150, PASTAS_LEQ_022
@@ -79,6 +79,24 @@ class PastaStore:
         self.plots = Plots(self)
         self.yaml = PastastoreYAML(self)
 
+    @classmethod
+    def from_pastastore_config_file(cls, fname):
+        """Create a PastaStore from a pastastore config file."""
+        with open(fname, "r") as f:
+            cfg = json.load(f)
+
+        conn_type = cfg.pop("connector_type")
+        if conn_type == "pas":
+            conn = PasConnector(**cfg)
+        elif conn_type == "arcticdb":
+            conn = ArcticDBConnector(**cfg)
+        else:
+            raise ValueError(
+                f"Cannot load connector type: '{conn_type}'. "
+                "This is only supported for PasConnector and ArcticDBConnector."
+            )
+        return cls(conn)
+
     @property
     def empty(self) -> bool:
         """Check if the PastaStore is empty."""
@@ -120,12 +138,43 @@ class PastaStore:
 
     @property
     def models(self):
-        """Return list of model names.
+        """Return the ModelAccessor object.
+
+        The ModelAccessor object allows dictionary-like assignment and access to models.
+        In addition it provides some useful utilities for working with stored models
+        in the database.
+
+        Examples
+        --------
+        Get a model by name::
+
+        >>> model = pstore.models["my_model"]
+
+        Store a model in the database::
+
+        >>> pstore.models["my_model_v2"] = model
+
+        Get model metadata dataframe::
+
+        >>> pstore.models.metadata
+
+        Number of models::
+
+        >>> len(pstore.models)
+
+        Random model::
+
+        >>> model = pstore.models.random()
+
+        Iterate over stored models::
+
+        >>> for ml in pstore.models:
+        >>>     ml.solve()
 
         Returns
         -------
-        list
-            list of model names
+        ModelAccessor
+            ModelAccessor object
         """
         return self.conn.models
 
@@ -1373,7 +1422,7 @@ class PastaStore:
 
         if os.path.exists(fname) and not overwrite:
             raise FileExistsError(
-                "File already exists! " "Use 'overwrite=True' to " "force writing file."
+                "File already exists! Use 'overwrite=True' to force writing file."
             )
         elif os.path.exists(fname):
             warnings.warn(f"Overwriting file '{os.path.basename(fname)}'", stacklevel=1)
@@ -1548,7 +1597,10 @@ class PastaStore:
                 "models": self.model_names,
             }
         else:
-            raise ValueError("Provide valid libname: 'models', 'stresses' or 'oseries'")
+            raise ValueError(
+                "Provide valid libname: 'models', 'stresses', 'oseries' or None"
+                " to seach within all libraries."
+            )
 
         result = {}
         for lib, names in lib_names.items():

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/styling.py

@@ -57,12 +57,12 @@ def boolean_styler(b):
     """
     if b:
         return (
-            f"background-color: {rgb2hex((231/255, 255/255, 239/255))}; "
+            f"background-color: {rgb2hex((231 / 255, 255 / 255, 239 / 255))}; "
             "color: darkgreen"
         )
     else:
         return (
-            f"background-color: {rgb2hex((255/255, 238/255, 238/255))}; "
+            f"background-color: {rgb2hex((255 / 255, 238 / 255, 238 / 255))}; "
             "color: darkred"
         )
 
@@ -90,11 +90,11 @@ def boolean_row_styler(row, column):
     """
     if row[column]:
         return (
-            f"background-color: {rgb2hex((231/255, 255/255, 239/255))}; "
+            f"background-color: {rgb2hex((231 / 255, 255 / 255, 239 / 255))}; "
             "color: darkgreen",
         ) * row.size
     else:
         return (
-            f"background-color: {rgb2hex((255/255, 238/255, 238/255))}; "
+            f"background-color: {rgb2hex((255 / 255, 238 / 255, 238 / 255))}; "
             "color: darkred",
         ) * row.size

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/util.py

@@ -1,6 +1,7 @@
 """Useful utilities for pastastore."""
 
 import os
+import shutil
 from typing import Dict, List, Optional, Union
 
 import numpy as np
@@ -43,8 +44,6 @@ def delete_arcticdb_connector(
         list of library names to delete, by default None which deletes
         all libraries
     """
-    import shutil
-
     import arcticdb
 
     if conn is not None:
@@ -75,9 +74,17 @@ def delete_arcticdb_connector(
             print()
             print(f" - deleted: {lib}")
 
-    remaining = [ilib for ilib in arc.list_libraries() if ilib.split(".") == name]
+    # delete .pastastore file if entire pastastore is deleted
+    remaining_libs = [
+        ilib for ilib in arc.list_libraries() if ilib.split(".")[0] == name
+    ]
+    if remaining_libs == 0:
+        os.unlink(os.path.join(uri.split("//")[-1], f"{name}.pastastore"))
+
+    # check if any remaining libraries in lmdb dir, if none, delete entire folder
+    remaining = arc.list_libraries()
     if len(remaining) == 0:
-        shutil.rmtree(os.path.join(conn.uri.split("//")[-1], name))
+        shutil.rmtree(os.path.join(conn.uri.split("//")[-1]))
 
     print("Done!")
 
@@ -98,8 +105,6 @@ def delete_dict_connector(conn, libraries: Optional[List[str]] = None) -> None:
 
 def delete_pas_connector(conn, libraries: Optional[List[str]] = None) -> None:
     """Delete PasConnector object."""
-    import shutil
-
     print(f"Deleting PasConnector database: '{conn.name}' ... ", end="")
     if libraries is None:
         shutil.rmtree(conn.path)
@@ -143,7 +148,7 @@ def delete_pastastore(pstore, libraries: Optional[List[str]] = None) -> None:
         delete_pas_connector(conn=pstore.conn, libraries=libraries)
     else:
         raise TypeError(
-            "Unrecognized pastastore Connector type: " f"{pstore.conn.conn_type}"
+            f"Unrecognized pastastore Connector type: {pstore.conn.conn_type}"
         )
 
 
@@ -545,7 +550,7 @@ def frontiers_checks(
         ml = pstore.get_models(mlnam)
 
         if ml.parameters["optimal"].hasnans:
-            print(f"Warning! Skipping model '{mlnam}' because " "it is not solved!")
+            print(f"Warning! Skipping model '{mlnam}' because it is not solved!")
             continue
 
         checks = pd.DataFrame(columns=["stat", "threshold", "units", "check_passed"])
@@ -752,8 +757,7 @@ def frontiers_aic_select(
             modelnames += pstore.oseries_models[o]
     elif oseries is not None:
         print(
-            "Warning! Both 'modelnames' and 'oseries' provided, "
-            "using only 'modelnames'"
+            "Warning! Both 'modelnames' and 'oseries' provided, using only 'modelnames'"
         )
 
     # Dataframe of models with corresponding oseries

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/version.py

@@ -9,7 +9,7 @@ PASTAS_VERSION = parse_version(ps.__version__)
 PASTAS_LEQ_022 = PASTAS_VERSION <= parse_version("0.22.0")
 PASTAS_GEQ_150 = PASTAS_VERSION >= parse_version("1.5.0")
 
-__version__ = "1.8.0"
+__version__ = "1.9.0"
 
 
 def show_versions(optional=False) -> None:

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore/yaml_interface.py

@@ -3,6 +3,8 @@
 import datetime
 import logging
 import os
+import tempfile
+from contextlib import contextmanager
 from copy import deepcopy
 from typing import Any, Dict, List, Optional, Union
 
@@ -124,6 +126,18 @@ def reduce_to_minimal_dict(d, keys=None):
             reduce_to_minimal_dict(v, keys=keys)
 
 
+@contextmanager
+def temporary_yaml_from_str(yaml):
+    """Temporary yaml file that is deleted after usage."""
+    temp = tempfile.NamedTemporaryFile(delete=False)
+    temp.write(yaml.encode("utf-8"))
+    temp.close()
+    try:
+        yield temp.name
+    finally:
+        os.unlink(temp.name)
+
+
 class PastastoreYAML:
     """Class for reading/writing Pastas models in YAML format.
 
@@ -427,7 +441,7 @@ class PastastoreYAML:
                     .values
                 )
                 logger.info(
-                    f"  | using {n} nearest stress(es) with kind='{kind}': " f"{snames}"
+                    f"  | using {n} nearest stress(es) with kind='{kind}': {snames}"
                 )
             else:
                 snames = [snames]
@@ -533,7 +547,10 @@ class PastastoreYAML:
             if (
                 smnam.lower() in ["rch", "rech", "recharge", "rechargemodel"]
             ) and not smtyp:
-                logger.info("| assuming RechargeModel based on stressmodel name.")
+                logger.info(
+                    "| no StressModel type provided, using 'RechargeModel' based on "
+                    "stressmodel name."
+                )
                 # check if stressmodel dictionary is empty, create (nearly
                 # empty) dict so defaults are used
                 if smyml is None:
@@ -547,14 +564,14 @@ class PastastoreYAML:
                 # cannot make any assumptions for non-RechargeModels
                 if smyml is None:
                     raise ValueError(
-                        "Insufficient information " f"for stressmodel '{name}'!"
+                        f"Insufficient information for stressmodel '{name}'!"
                     )
                 # get stressmodel type, with default StressModel
                 if classkey in smyml:
                     smtyp = smyml[classkey]
                 else:
                     logger.info(
-                        "| no stressmodel class type provided, " "using 'StressModel'"
+                        "| no stressmodel class type provided, using 'StressModel'"
                     )
                     smtyp = "StressModel"
 
@@ -574,7 +591,7 @@ class PastastoreYAML:
                 sm = self._parse_wellmodel_dict(smyml, onam=onam)
             else:
                 raise NotImplementedError(
-                    "PastaStore.yaml interface does " f"not (yet) support '{smtyp}'!"
+                    f"PastaStore.yaml interface does not (yet) support '{smtyp}'!"
                 )
 
             # add to list
@@ -604,7 +621,7 @@ class PastastoreYAML:
         Parameters
         ----------
         fyaml : str
-            path to file
+            YAML as str or path to file
 
         Returns
         -------
@@ -618,8 +635,18 @@ class PastastoreYAML:
         NotImplementedError
             if unsupported stressmodel is encountered
         """
-        with open(fyaml, "r") as f:
-            yml = yaml.load(f, Loader=yaml.CFullLoader)
+        if "\n" in fyaml or "\r" in fyaml:
+            with temporary_yaml_from_str(fyaml) as fyaml:
+                with open(fyaml, "r") as f:
+                    yml = yaml.load(f, Loader=yaml.CFullLoader)
+        elif os.path.exists(fyaml):
+            with open(fyaml, "r") as f:
+                yml = yaml.load(f, Loader=yaml.CFullLoader)
+        else:
+            raise ValueError(
+                "Could not read YAML file! Check if input is valid YAML "
+                "or valid path to YAML file."
+            )
 
         models = []
 

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pastastore
-Version: 1.8.0
+Version: 1.9.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>
 License: The MIT License (MIT)
         
-        Copyright (c) 2020 D.A. Brakenhoff
+        Copyright (c) 2020-2025 D.A. Brakenhoff
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
@@ -40,13 +40,13 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Scientific/Engineering :: Hydrology
-Requires-Python: >=3.7
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pastas>=0.13
@@ -65,26 +65,17 @@ Provides-Extra: arcticdb
 Requires-Dist: arcticdb; extra == "arcticdb"
 Provides-Extra: lint
 Requires-Dist: ruff; extra == "lint"
+Provides-Extra: pytest
+Requires-Dist: coverage; extra == "pytest"
+Requires-Dist: codecov; extra == "pytest"
+Requires-Dist: pytest; extra == "pytest"
+Requires-Dist: pytest-cov; extra == "pytest"
+Requires-Dist: pytest-dependency; extra == "pytest"
+Requires-Dist: pytest-benchmark; extra == "pytest"
+Requires-Dist: codacy-coverage; extra == "pytest"
 Provides-Extra: test
-Requires-Dist: pastastore[arcticdb,lint,optional]; extra == "test"
+Requires-Dist: pastastore[arcticdb,lint,optional,pytest]; extra == "test"
 Requires-Dist: hydropandas[full]; extra == "test"
-Requires-Dist: coverage; extra == "test"
-Requires-Dist: codecov; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-dependency; extra == "test"
-Requires-Dist: pytest-benchmark; extra == "test"
-Requires-Dist: codacy-coverage; extra == "test"
-Provides-Extra: test-py312
-Requires-Dist: pastastore[lint,optional]; extra == "test-py312"
-Requires-Dist: hydropandas[full]; extra == "test-py312"
-Requires-Dist: coverage; extra == "test-py312"
-Requires-Dist: codecov; extra == "test-py312"
-Requires-Dist: pytest; extra == "test-py312"
-Requires-Dist: pytest-cov; extra == "test-py312"
-Requires-Dist: pytest-dependency; extra == "test-py312"
-Requires-Dist: pytest-benchmark; extra == "test-py312"
-Requires-Dist: codacy-coverage; extra == "test-py312"
 Provides-Extra: docs
 Requires-Dist: pastastore[optional]; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
@@ -102,7 +93,7 @@ Requires-Dist: nbsphinx_link; extra == "docs"
 # pastastore
 
 This module stores 
-[Pastas](https://pastas.readthedocs.io/en/latest/) time series and models in a
+[Pastas](https://pastas.readthedocs.io/latest/) time series and models in a
 database.
 
 Storing time series and models in a database allows the user to manage time
@@ -187,4 +178,4 @@ pstore.to_zip("my_backup.zip")
 ```
 
 For more elaborate examples, refer to the
-[Notebooks](https://pastastore.readthedocs.io/en/latest/examples.html#example-notebooks).
+[Notebooks](https://pastastore.readthedocs.io/latest/examples.html#example-notebooks).

{pastastore-1.8.0 → pastastore-1.9.0}/pastastore.egg-info/requires.txt

@@ -28,9 +28,7 @@ contextily
 pyproj
 adjustText
 
-[test]
-pastastore[arcticdb,lint,optional]
-hydropandas[full]
+[pytest]
 coverage
 codecov
 pytest
@@ -39,13 +37,6 @@ pytest-dependency
 pytest-benchmark
 codacy-coverage
 
-[test_py312]
-pastastore[lint,optional]
+[test]
+pastastore[arcticdb,lint,optional,pytest]
 hydropandas[full]
-coverage
-codecov
-pytest
-pytest-cov
-pytest-dependency
-pytest-benchmark
-codacy-coverage

{pastastore-1.8.0 → pastastore-1.9.0}/pyproject.toml

@@ -15,7 +15,7 @@ maintainers = [
     { name = "R. Calje", email = "r.calje@artesia-water.nl" },
     { name = "M.A. Vonk", email = "m.vonk@artesia-water.nl" },
 ]
-requires-python = ">= 3.7"
+requires-python = ">= 3.10"
 dependencies = ["pastas>=0.13", "tqdm>=4.36", "pyyaml"]
 
 keywords = ["hydrology", "groundwater", "time series", "analysis", "database"]
@@ -30,10 +30,10 @@ classifiers = [
     "Operating System :: MacOS",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3 :: Only",
     "Topic :: Scientific/Engineering :: Hydrology",
 ]
@@ -49,20 +49,7 @@ extensions = ["hydropandas"]
 optional = ["contextily", "pyproj", "adjustText"]
 arcticdb = ["arcticdb"]
 lint = ["ruff"]
-test = [
-    "pastastore[arcticdb,lint,optional]",
-    "hydropandas[full]",
-    "coverage",
-    "codecov",
-    "pytest",
-    "pytest-cov",
-    "pytest-dependency",
-    "pytest-benchmark",
-    "codacy-coverage",
-]
-test_py312 = [
-    "pastastore[lint,optional]", # no arcticdb
-    "hydropandas[full]",
+pytest = [
     "coverage",
     "codecov",
     "pytest",
@@ -71,6 +58,7 @@ test_py312 = [
     "pytest-benchmark",
     "codacy-coverage",
 ]
+test = ["pastastore[arcticdb,lint,optional,pytest]", "hydropandas[full]"]
 docs = [
     "pastastore[optional]",
     "sphinx_rtd_theme",
@@ -116,7 +104,7 @@ markers = [
 ]
 
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.10"
 warn_return_any = true
 warn_unused_configs = true
 

{pastastore-1.8.0 → pastastore-1.9.0}/readme.md

@@ -7,7 +7,7 @@
 # pastastore
 
 This module stores 
-[Pastas](https://pastas.readthedocs.io/en/latest/) time series and models in a
+[Pastas](https://pastas.readthedocs.io/latest/) time series and models in a
 database.
 
 Storing time series and models in a database allows the user to manage time
@@ -92,4 +92,4 @@ pstore.to_zip("my_backup.zip")
 ```
 
 For more elaborate examples, refer to the
-[Notebooks](https://pastastore.readthedocs.io/en/latest/examples.html#example-notebooks).
+[Notebooks](https://pastastore.readthedocs.io/latest/examples.html#example-notebooks).

{pastastore-1.8.0 → pastastore-1.9.0}/tests/conftest.py

@@ -1,18 +1,14 @@
 # ruff: noqa: D100 D103
 import importlib
 from importlib import metadata
-from platform import python_version
 
 import pandas as pd
 import pastas as ps
 import pytest
-from packaging.version import parse as parse_version
 
 import pastastore as pst
 
-IS_PY312 = parse_version(python_version()) >= parse_version("3.12.0")
-
-params = ["dict", "pas", "arcticdb"] if not IS_PY312 else ["dict", "pas"]
+params = ["dict", "pas", "arcticdb"]
 
 
 def initialize_project(conn):

{pastastore-1.8.0 → pastastore-1.9.0}/tests/test_003_pastastore.py

@@ -168,6 +168,7 @@ def test_create_models(pstore):
         ["oseries1", "oseries2"], store=True, progressbar=False
     )
     _ = pstore.conn.models
+    assert pstore.n_models == 2
 
 
 @pytest.mark.dependency
@@ -252,15 +253,12 @@ def test_update_ts_settings(request, pstore):
 
     ml2 = pstore.get_models(ml.name, update_ts_settings=True)
 
-    try:
-        assert ml2.oseries.settings["tmax"] == o.index[-1]
-        assert ml2.stressmodels["recharge"].prec.settings["tmax"] == tmax
-        assert ml2.stressmodels["recharge"].evap.settings["tmax"] == tmax
-        assert ml2.stressmodels["prec"].stress[0].settings["tmax"] == p2.index[-1]
-    except AssertionError:
-        pstore.del_models("ml_oseries2")
-        pstore.set_check_model_series_values(True)
-        raise
+    assert ml2.oseries.settings["tmax"] == o.index[-1]
+    assert ml2.stressmodels["recharge"].prec.settings["tmax"] == tmax
+    assert ml2.stressmodels["recharge"].evap.settings["tmax"] == tmax
+    assert ml2.stressmodels["prec"].stress[0].settings["tmax"] == p2.index[-1]
+    pstore.del_models("ml_oseries2")
+    pstore.set_check_model_series_values(True)
 
 
 # @pytest.mark.dependency()
@@ -296,6 +294,16 @@ def test_to_from_zip(pstore):
         os.remove(zipname)
 
 
+def test_load_pastastore_from_config_file(pstore):
+    if pstore.type == "pas" or pstore.type == "arcticdb":
+        path = (
+            pstore.conn.path if pstore.type == "pas" else pstore.conn.uri.split("//")[1]
+        )
+        fname = os.path.join(path, f"{pstore.conn.name}.pastastore")
+        pstore2 = pst.PastaStore.from_pastastore_config_file(fname)
+        assert not pstore2.empty
+
+
 def test_example_pastastore():
     from pastastore.datasets import example_pastastore
 
@@ -319,3 +327,12 @@ def test_meta_with_name(pstore):
     pstore.add_stress(s, "what_i_want", kind="special", metadata=smeta)
     assert "what_i_want" in pstore.stresses.index, "This is not right."
     pstore.del_stress("what_i_want")
+
+
+@pytest.mark.dependency
+def test_models_metadata(request, pstore):
+    # depends(request, [f"test_create_models[{pstore.type}]"])
+    pstore.create_models_bulk(["oseries1", "oseries2"], store=True, progressbar=False)
+    df = pstore.models.metadata
+    assert df.index.size == 2
+    assert (df["n_stressmodels"] == 1).all()

{pastastore-1.8.0 → pastastore-1.9.0}/tests/test_006_benchmark.py

@@ -176,6 +176,3 @@ def test_benchmark_read_model_arcticdb(benchmark):
     conn = pst.ArcticDBConnector("test", uri)
     _ = benchmark(read_model, conn=conn)
     pst.util.delete_arcticdb_connector(conn=conn)
-    import shutil
-
-    shutil.rmtree("./arctic_db/")