pastastore 1.7.1__py3-none-any.whl → 1.7.2__py3-none-any.whl

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.7.1"
+__version__ = "1.7.2"
 
 
 def show_versions(optional=False) -> None:

{pastastore-1.7.1.dist-info → pastastore-1.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pastastore
-Version: 1.7.1
+Version: 1.7.2
 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>

pastastore-1.7.2.dist-info/RECORD

@@ -0,0 +1,28 @@
+docs/conf.py,sha256=XcZUTmn9fGDhhu8k3mpaLu435SpIRNpABADCCTJJuag,6291
+pastastore/__init__.py,sha256=cWwG9-YeiI4aOU0CDBGKbQgmKmmkcPd64YwPq2rRGt0,416
+pastastore/base.py,sha256=gngnJOL4b4TNgPysRsxdyeg726ZNV2anQviNr5nnrqs,69101
+pastastore/connectors.py,sha256=YK3I_Jb2uNwzBQvN2VwZvmTRfPeUETW-4ddcFSWkHVw,16820
+pastastore/datasets.py,sha256=FHVfmKqb8beEs9NONsWrCoJY37BmlvFLSEQ1VAFmE8A,6415
+pastastore/plotting.py,sha256=t6gEeHVGzrwvM6q1l8V3OkklpU75O2Y4h6nKEHRWdjo,46416
+pastastore/store.py,sha256=xbv1prv6QqYj8M-2c77CT0ZQejjmNSldpuqu_M4WxoU,60906
+pastastore/styling.py,sha256=4xAY0FmhKrvmAGIuoMM7Uucww_X4KAxTpEoHlsxMldc,2280
+pastastore/util.py,sha256=iXHoGHfK6VDbUpufNsnzdV71oBVp-koZUD4VJj6MOwo,28250
+pastastore/version.py,sha256=CNSMFFOsy1MPe400qfRtqb8M-LE8iUmm7u0QSZZUOfE,1205
+pastastore/yaml_interface.py,sha256=MddELxWe8_aqJRMUydOCbjoU1-ZodzxFKYnAaqJ5SqA,29947
+pastastore/extensions/__init__.py,sha256=lCN9xfX1qefUzUbE2FQ12c6NjLbf5HoNo-D8cGb5CTw,461
+pastastore/extensions/accessor.py,sha256=kftQM6dqMDoySbyTKcvmkjC5gJRp465KA18G4NVXUO0,367
+pastastore/extensions/hpd.py,sha256=w8_13Y_1bzgxCT8RJ2L6D_eTpYGpniSbxA4CoUw_CgI,27464
+tests/conftest.py,sha256=u097z7LGAnviuzXPzvER9oPjsZWqdij1CJLnW_sPY8E,5258
+tests/test_001_import.py,sha256=g8AaJzWZ088A4B30_w-MrDfAVeeg8m78l--j7Onsklc,208
+tests/test_002_connectors.py,sha256=k9etSRuSFVOrSEtZyxqsCF9GwIg0T7VdDJ2SjSe6i_s,7742
+tests/test_003_pastastore.py,sha256=uVGqM0RwYqnt2dxlj3i3YO7lG0LAfeg8gSG2QLm4lTI,9320
+tests/test_004_yaml.py,sha256=3hMNjb9s0S2rbmpyEjW6FDRAxfUZS_U1qoPl4wB-cCo,4440
+tests/test_005_maps_plots.py,sha256=L0ppGf-cudsrdxteWy3qsV4We96DW4bCBE7c6jEm6aM,1866
+tests/test_006_benchmark.py,sha256=yuExF35qqxhw04uYMH3OIOlGr71c4AJSJDMjGD8GefY,4983
+tests/test_007_hpdextension.py,sha256=ZYrJ16hNE2Cy6gucMW_0-NoCmlimsPQ5oNA5H67HGBg,2937
+tests/test_008_stressmodels.py,sha256=733fyCvuzjKcaLjvSMt5dTTLp-T4alzNJAToSxTIUug,4003
+pastastore-1.7.2.dist-info/LICENSE,sha256=DtHftfUEm99KzgwLr3rQUTg8H3kAS0Z-p5WWJgLf_OY,1082
+pastastore-1.7.2.dist-info/METADATA,sha256=j_lnxfuDY6aLfSjm71PVA79hUCn18AuIxGycHUhXAcc,8021
+pastastore-1.7.2.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+pastastore-1.7.2.dist-info/top_level.txt,sha256=1bgyMk1p23f04RK83Jju2_YAQBwyoQD_fInxoPB4YRw,22
+pastastore-1.7.2.dist-info/RECORD,,

{pastastore-1.7.1.dist-info → pastastore-1.7.2.dist-info}/top_level.txt

@@ -1 +1,3 @@
+docs
 pastastore
+tests

tests/conftest.py

@@ -0,0 +1,169 @@
+# 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"]
+
+
+def initialize_project(conn):
+    pstore = pst.PastaStore(conn, "test_project")
+
+    # oseries 1
+    o = pd.read_csv("./tests/data/obs.csv", index_col=0, parse_dates=True)
+    pstore.add_oseries(o, "oseries1", metadata={"x": 165000, "y": 424000})
+
+    # oseries 2
+    o = pd.read_csv("./tests/data/head_nb1.csv", index_col=0, parse_dates=True)
+    pstore.add_oseries(o, "oseries2", metadata={"x": 164000, "y": 423000})
+
+    # oseries 3
+    o = pd.read_csv("./tests/data/gw_obs.csv", index_col=0, parse_dates=True)
+    pstore.add_oseries(o, "oseries3", metadata={"x": 165554, "y": 422685})
+
+    # prec 1
+    s = pd.read_csv("./tests/data/rain.csv", index_col=0, parse_dates=True)
+    pstore.add_stress(s, "prec1", kind="prec", metadata={"x": 165050, "y": 424050})
+
+    # prec 2
+    s = pd.read_csv("./tests/data/rain_nb1.csv", index_col=0, parse_dates=True)
+    pstore.add_stress(s, "prec2", kind="prec", metadata={"x": 164010, "y": 423000})
+
+    # evap 1
+    s = pd.read_csv("./tests/data/evap.csv", index_col=0, parse_dates=True)
+    pstore.add_stress(s, "evap1", kind="evap", metadata={"x": 164500, "y": 424000})
+
+    # evap 2
+    s = pd.read_csv("./tests/data/evap_nb1.csv", index_col=0, parse_dates=True)
+    pstore.add_stress(s, "evap2", kind="evap", metadata={"x": 164000, "y": 423030})
+
+    # well 1
+    s = pd.read_csv("./tests/data/well_month_end.csv", index_col=0, parse_dates=True)
+    try:
+        s = ps.ts.timestep_weighted_resample(
+            s,
+            pd.date_range(s.index[0] - pd.offsets.MonthBegin(), s.index[-1], freq="D"),
+        ).bfill()
+    except AttributeError:
+        # pastas<=0.22.0
+        pass
+    pstore.add_stress(s, "well1", kind="well", metadata={"x": 164691, "y": 423579})
+    # add second well
+    pstore.add_stress(
+        s + 10, "well2", kind="well", metadata={"x": 164691 + 200, "y": 423579_200}
+    )
+
+    return pstore
+
+
+@pytest.fixture(scope="module", params=params)
+def conn(request):
+    """Fixture that yields connection object."""
+    name = f"test_{request.param}"
+    # connect to dbase
+    if request.param == "arcticdb":
+        uri = "lmdb://./arctic_db/"
+        conn = pst.ArcticDBConnector(name, uri)
+    elif request.param == "dict":
+        conn = pst.DictConnector(name)
+    elif request.param == "pas":
+        conn = pst.PasConnector(name, "./tests/data")
+    else:
+        raise ValueError("Unrecognized parameter!")
+    conn.type = request.param  # added here for defining test dependencies
+    return conn
+
+
+@pytest.fixture(scope="module", params=params)
+def pstore(request):
+    if request.param == "arcticdb":
+        name = "test_project"
+        uri = "lmdb://./arctic_db/"
+        connector = pst.ArcticDBConnector(name, uri)
+    elif request.param == "dict":
+        name = "test_project"
+        connector = pst.DictConnector(name)
+    elif request.param == "pas":
+        name = "test_project"
+        connector = pst.PasConnector(name, "./tests/data/pas")
+    else:
+        raise ValueError("Unrecognized parameter!")
+    pstore = initialize_project(connector)
+    pstore.type = request.param  # added here for defining test dependencies
+    yield pstore
+    pst.util.delete_pastastore(pstore)
+
+
+def delete_arcticdb_test_db():
+    connstr = "lmdb://./arctic_db/"
+    name = "test_project"
+    connector = pst.ArcticDBConnector(name, connstr)
+    pst.util.delete_arcticdb_connector(connector)
+    print("ArcticDBConnector 'test_project' deleted.")
+
+
+_has_pkg_cache = {}
+
+
+def has_pkg(pkg: str, strict: bool = True) -> bool:
+    """
+    Determine if the given Python package is installed.
+
+    Parameters
+    ----------
+    pkg : str
+        Name of the package to check.
+    strict : bool
+        If False, only check if package metadata is available.
+        If True, try to import the package (all dependencies must be present).
+
+    Returns
+    -------
+    bool
+        True if the package is installed, otherwise False.
+
+    Notes
+    -----
+    Originally written by Mike Toews (mwtoews@gmail.com) for FloPy.
+    """
+
+    def try_import():
+        try:  # import name, e.g. "import shapefile"
+            importlib.import_module(pkg)
+            return True
+        except ModuleNotFoundError:
+            return False
+
+    def try_metadata() -> bool:
+        try:  # package name, e.g. pyshp
+            metadata.distribution(pkg)
+            return True
+        except metadata.PackageNotFoundError:
+            return False
+
+    found = False
+    if not strict:
+        found = pkg in _has_pkg_cache or try_metadata()
+    if not found:
+        found = try_import()
+    _has_pkg_cache[pkg] = found
+
+    return _has_pkg_cache[pkg]
+
+
+def requires_pkg(*pkgs):
+    missing = {pkg for pkg in pkgs if not has_pkg(pkg, strict=True)}
+    return pytest.mark.skipif(
+        missing,
+        reason=f"missing package{'s' if len(missing) != 1 else ''}: "
+        + ", ".join(missing),
+    )

tests/test_001_import.py

@@ -0,0 +1,8 @@
+# ruff: noqa: D100 D103
+import warnings
+
+
+def test_import():
+    with warnings.catch_warnings():
+        warnings.simplefilter(action="ignore", category=FutureWarning)
+        import pastastore  # noqa: F401

tests/test_002_connectors.py

@@ -0,0 +1,277 @@
+# ruff: noqa: D100 D103
+import warnings
+
+import numpy as np
+import pandas as pd
+import pastas as ps
+import pytest
+from pytest_dependency import depends
+
+with warnings.catch_warnings():
+    warnings.simplefilter(action="ignore", category=FutureWarning)
+    import pastastore as pst
+
+ps.set_log_level("ERROR")
+
+
+def test_get_library(conn):
+    _ = conn._get_library("oseries")
+
+
+def test_add_get_series(request, conn):
+    o1 = pd.Series(
+        index=pd.date_range("2000", periods=10, freq="D"),
+        data=0.0,
+    )
+    o1.name = "test_series"
+    conn.add_oseries(o1, "test_series", metadata=None)
+    o2 = conn.get_oseries("test_series")
+    try:
+        assert isinstance(o2, pd.Series)
+        assert o1.equals(o2)
+        assert o1.dtype == o2.dtype
+    finally:
+        conn.del_oseries("test_series")
+
+
+def test_add_get_series_wnans(request, conn):
+    o1 = pd.Series(
+        index=pd.date_range("2000", periods=10, freq="D"),
+        data=1.0,
+        dtype=np.float64,
+    )
+    o1.iloc[-3:] = np.nan
+    o1.name = "test_series_nans"
+    conn.add_oseries(o1, "test_series_nans", metadata=None)
+    o2 = conn.get_oseries("test_series_nans")
+    try:
+        assert isinstance(o2, pd.Series)
+        assert o1.equals(o2)
+    finally:
+        conn.del_oseries("test_series_nans")
+
+
+def test_add_get_dataframe(request, conn):
+    o1 = pd.DataFrame(
+        data=1.0,
+        columns=["test_df"],
+        index=pd.date_range("2000", periods=10, freq="D"),
+    )
+    o1.index.name = "test_idx"
+    conn.add_oseries(o1, "test_df", metadata=None)
+    o2 = conn.get_oseries("test_df")
+    # little hack as PasConnector does preserve DataFrames after load...
+    if conn.conn_type == "pas":
+        o2 = o2.to_frame()
+    try:
+        assert isinstance(o2, pd.DataFrame)
+        assert o1.equals(o2)
+    finally:
+        conn.del_oseries("test_df")
+
+
+def test_add_pastas_timeseries(request, conn):
+    o1 = pd.DataFrame(
+        data=1.0,
+        columns=["test_df"],
+        index=pd.date_range("2000", periods=10, freq="D"),
+    )
+    o1.index.name = "test_idx"
+    ts = ps.timeseries.TimeSeries(o1, metadata={"x": 100000.0, "y": 400000.0})
+    try:
+        conn.add_oseries(ts, "test_pastas_ts", metadata=None)
+    except DeprecationWarning:
+        pass
+
+
+def test_update_series(request, conn):
+    o1 = pd.DataFrame(
+        data=1.0,
+        columns=["test_df"],
+        index=pd.date_range("2000", periods=10, freq="D"),
+    )
+    o1.index.name = "test_idx"
+    conn.add_oseries(o1, "test_df", metadata={"x": 100000.0})
+    o2 = pd.DataFrame(
+        data=2.0,
+        columns=["test_df"],
+        index=pd.date_range("2000-01-10", periods=2, freq="D"),
+    )
+    o2.index.name = "test_idx"
+    conn.update_oseries(o2, "test_df", metadata={"x": 200000.0, "y": 400000})
+    o3 = conn.get_oseries("test_df")
+    try:
+        assert (o3.iloc[-2:] == 2.0).all().all()
+        assert o3.index.size == 11
+    finally:
+        conn.del_oseries("test_df")
+
+
+def test_upsert_oseries(request, conn):
+    o1 = pd.DataFrame(
+        data=1.0,
+        columns=["test_df"],
+        index=pd.date_range("2000", periods=10, freq="D"),
+    )
+    o1.index.name = "test_idx"
+    conn.upsert_oseries(o1, "test_df", metadata={"x": 100000.0})
+    o2 = pd.DataFrame(
+        data=2.0,
+        columns=["test_df"],
+        index=pd.date_range("2000-01-05", periods=10, freq="D"),
+    )
+    o2.index.name = "test_idx"
+    conn.upsert_oseries(o2, "test_df", metadata={"x": 200000.0, "y": 400000})
+    o3 = conn.get_oseries("test_df")
+    try:
+        assert (o3.iloc[-10:] == 2.0).all().all()
+        assert o3.index.size == 14
+    finally:
+        conn.del_oseries("test_df")
+
+
+def test_upsert_stress(request, conn):
+    s1 = pd.DataFrame(
+        data=1.0,
+        columns=["test_df"],
+        index=pd.date_range("2000", periods=10, freq="D"),
+    )
+    s1.index.name = "test_idx"
+    conn.upsert_stress(s1, "test_df", kind="useless", metadata={"x": 100000.0})
+    s2 = pd.DataFrame(
+        data=2.0,
+        columns=["test_df"],
+        index=pd.date_range("2000-01-05", periods=10, freq="D"),
+    )
+    s2.index.name = "test_idx"
+    conn.upsert_stress(
+        s2,
+        "test_df",
+        kind="not useless",
+        metadata={"x": 200000.0, "y": 400000},
+    )
+    s3 = conn.get_stresses("test_df")
+    try:
+        assert (s3.iloc[-10:] == 2.0).all().all()
+        assert s3.index.size == 14
+        assert conn.stresses.loc["test_df", "kind"] == "not useless"
+    finally:
+        conn.del_stress("test_df")
+
+
+def test_update_metadata(request, conn):
+    o1 = pd.DataFrame(
+        data=1.1,
+        columns=["test_df"],
+        index=pd.date_range("2000", periods=10, freq="D"),
+        dtype=float,
+    )
+    o1.index.name = "test_idx"
+    conn.add_oseries(o1, "test_df", metadata={"x": 100000.0})
+    conn.update_metadata("oseries", "test_df", {"x": 200000.0, "y": 400000.0})
+    m = conn._get_metadata("oseries", "test_df")
+    try:
+        assert isinstance(m, dict)
+        assert m["x"] == 200000.0
+        assert m["y"] == 400000.0
+    finally:
+        conn.del_oseries("test_df")
+
+
+@pytest.mark.dependency
+def test_add_oseries(conn):
+    o = pd.read_csv("./tests/data/obs.csv", index_col=0, parse_dates=True)
+    conn.add_oseries(
+        o,
+        "oseries1",
+        metadata={"name": "oseries1", "x": 100000, "y": 400000},
+        overwrite=True,
+    )
+
+
+@pytest.mark.dependency
+def test_add_stress(conn):
+    s = pd.read_csv("./tests/data/rain.csv", index_col=0, parse_dates=True)
+    conn.add_stress(
+        s,
+        "prec",
+        kind="prec",
+        metadata={"kind": "prec", "x": 100001, "y": 400001},
+    )
+
+
+@pytest.mark.dependency
+def test_get_oseries(request, conn):
+    depends(request, [f"test_add_oseries[{conn.type}]"])
+    _ = conn.get_oseries("oseries1")
+
+
+@pytest.mark.dependency
+def test_get_oseries_and_metadata(request, conn):
+    depends(request, [f"test_add_oseries[{conn.type}]"])
+    _ = conn.get_oseries("oseries1", return_metadata=True)
+
+
+@pytest.mark.dependency
+def test_get_stress(request, conn):
+    depends(request, [f"test_add_stress[{conn.type}]"])
+    s = conn.get_stresses("prec")
+    s.name = "prec"
+
+
+@pytest.mark.dependency
+def test_get_stress_and_metadata(request, conn):
+    depends(request, [f"test_add_stress[{conn.type}]"])
+    s, _ = conn.get_stresses("prec", return_metadata=True)
+    s.name = "prec"
+
+
+@pytest.mark.dependency
+def test_oseries_prop(request, conn):
+    depends(request, [f"test_add_oseries[{conn.type}]"])
+    _ = conn.oseries
+
+
+@pytest.mark.dependency
+def test_stresses_prop(request, conn):
+    depends(request, [f"test_add_stress[{conn.type}]"])
+    _ = conn.stresses
+
+
+def test_repr(conn):
+    conn.__repr__()
+
+
+@pytest.mark.dependency
+def test_del_oseries(request, conn):
+    depends(request, [f"test_add_oseries[{conn.type}]"])
+    conn.del_oseries("oseries1")
+
+
+@pytest.mark.dependency
+def test_del_stress(request, conn):
+    depends(request, [f"test_add_stress[{conn.type}]"])
+    conn.del_stress("prec")
+
+
+@pytest.mark.dependency
+def test_empty_library(request, conn):
+    s1 = pd.Series(
+        index=pd.date_range("2000", periods=10, freq="D"),
+        data=1.0,
+        dtype=np.float64,
+    )
+    s1.name = "test_series"
+    conn.add_oseries(s1, "test_series", metadata=None)
+    conn.empty_library("oseries", prompt=False, progressbar=False)
+
+
+@pytest.mark.dependency
+def test_delete(request, conn):
+    # no need to delete dictconnector (in memory)
+    if conn.conn_type == "arcticdb":
+        pst.util.delete_arcticdb_connector(conn, libraries=["oseries"])
+        pst.util.delete_arcticdb_connector(conn)
+    elif conn.conn_type == "pas":
+        pst.util.delete_pas_connector(conn, libraries=["oseries"])
+        pst.util.delete_pas_connector(conn)