WIP: persistence models

packages/bundled_models/persistence/.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

packages/bundled_models/persistence/.gitignore

@@ -0,0 +1,4 @@
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+report.xml

packages/bundled_models/persistence/README.md

@@ -0,0 +1,45 @@
+# Persistence Model for use with the PyEarthTools Package
+
+**TODO: description**
+
+## Installation
+
+Clone the repository, then run
+```shell
+pip install -e .
+```
+
+## Training
+
+No training is required for this model. It computes persistence on-the-fly using historical data loaded via the PET pipeline.
+
+## Predictions / Inference
+
+You can generate persistence values out of the box using the `pet predict` command line API, or by using a Jupyter Notebook as demonstrated in the tutorial gallery.
+
+```shell
+pet predict
+```
+
+and `Development/Persistence` should be visible.
+
+If so, you can now run some inference.
+
+```shell
+pet predict --model Development/Persistence
+```
+
+When running the command, it will prompt for other required arguments.
+
+**TODO: description of required arguments**
+
+
+#### Example
+
+```shell
+pet predict --model Development/Persistence # TODO
+```
+
+## Acknowledgments
+
+Not applicable. Heuristically developed.

packages/bundled_models/persistence/pyproject.toml

@@ -0,0 +1,92 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyearthtools-bundled-persistence"
+version = "0.6.0"
+description = "Persistence Bundled Model"
+readme = "README.md"
+requires-python = ">=3.11, <3.14"
+keywords = ["persistence", "pyearthtools", "models"]
+maintainers = [
+  {name = "Tennessee Leeuwenburg", email = "tennessee.leeuwenburg@bom.gov.au"},
+  {name = "Nikeeth Ramanathan", email = "nikeeth.ramanathan@gmail.com"},
+]
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+ 'pyearthtools.zoo>=0.5.0',
+ 'pyearthtools.data>=0.5.0',
+ 'pyearthtools.pipeline>=0.5.0',
+ 'hydra-core',
+]
+[dependency-groups]
+dev = [
+  "pytest>=8.4.2",
+  "ruff",
+  "pytest-cov",
+  "pytest-xdist",
+]
+
+[project.urls]
+homepage = "https://pyearthtools.readthedocs.io/"
+documentation = "https://pyearthtools.readthedocs.io/"
+repository = "https://github.com/ACCESS-Community-Hub/PyEarthTools"
+
+[project.entry-points."pyearthtools.zoo.model"]
+Global_PERSIST = "persistence.registered_model:Persistence"
+
+[tool.isort]
+profile = "black"
+
+[tool.black]
+line-length = 120
+
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+
+[tool.hatch.version]
+# TODO: is this the right path?
+path = "src/pyearthtools/pipeline/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyearthtools/"]
+
+[tool.pixi.workspace]
+channels = ["conda-forge"]
+platforms = ["linux-64"]
+
+[tool.pixi.pypi-dependencies]
+pyearthtools-bundled-persistence = { path = ".", editable = true }
+
+[tool.pixi.tasks]
+
+[tool.pixi.dependencies]
+python = ">=3.11,<3.14"
+xarray = ">=2026.1.0,<2027"
+
+[tool.pixi.feature.testing.dependencies]
+pytest = ">=9.0.2,<10"
+pytest-cov = ">=7.0.0,<8"
+pytest-xdist = ">=3.8.0,<4"
+ruff = ">=0.15.0,<0.16"
+ipython = ">=9.10.0,<10"
+
+[tool.pixi.feature.dask.dependencies]
+dask-core = "*"
+distributed = "*"
+pyarrow = ">=23.0.0,<24"
+
+[tool.pixi.environments]
+dask = ["dask"]
+dev = ["dask", "testing"]

packages/bundled_models/persistence/src/persistence/daskconfig.py

@@ -0,0 +1,41 @@
+from contextlib import contextmanager
+
+
+# default scheduler string to set "single-threaded" mode.
+_STR_DASK_SYNC_SCHEDULER = "synchronous"
+
+
+@contextmanager
+def _set_synchronous_dask():
+    """
+    Wrapper to set `dask` to single-threaded mode. Note: "single-threaded" in `dask`-land
+    (specifically) is the same as "synchronous".
+
+    This handles the case where dask is _not_ installed. In which case it does a pass-through.
+
+    IMPORTANT: never nest this context manager or call dask.config.reset() or attempt to update any
+    configs inside this context. Doing so may invalidate the "synchronous" setting.
+
+    Example:
+        def do_stuff(...):
+            # I can now (optionally) fork other processes here - without confusing dask.
+            # IMPORTANT: I shouldn't try to reintroduce parallelism using dask here
+            ...
+
+        with _set_synchronous_dask():
+            do_stuff(...)
+    """
+    try:
+        # this import order is important for the "distributed" configs to be recognized
+        import dask
+        import dask.config
+
+        # NOTE: if you don't have dask.distributed, this setting may not work as intended.
+        # so you will have to manually deal with it in the compute level.
+        import dask.distributed
+
+        # set state to desired config
+        with dask.config.set(scheduler=_STR_DASK_SYNC_SCHEDULER):
+            yield
+    except ImportError:
+        yield

packages/bundled_models/persistence/src/persistence/interface/_backends.py

@@ -0,0 +1,29 @@
+from enum import StrEnum, auto
+
+
+class PersistenceBackendType(StrEnum):
+    """
+    Supported compute backends.
+
+    NOTE: only NUMPY is currently supported
+    """
+
+    NUMPY = "numpy"
+    NUMBA = "numba"
+    RUST = "rust"
+    UNKNOWN = auto()
+
+    # overridable
+    def check_support(self):
+        """
+        This check only guarentees that a particular computation mechanism or library is available.
+        Individual methods may still not support a particular backend and that check is handled at a
+        lower level.
+        """
+        match self:
+            case PersistenceBackendType.NUMPY:
+                return
+            case _:
+                raise NotImplementedError(
+                    f"PersistenceBackendType: {self} is not supported"
+                )