ezmsg-sigproc 2.1.0__py3-none-any.whl → 2.2.0__py3-none-any.whl

ezmsg/sigproc/__version__.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.1.0'
-__version_tuple__ = version_tuple = (2, 1, 0)
+__version__ = version = '2.2.0'
+__version_tuple__ = version_tuple = (2, 2, 0)

ezmsg/sigproc/filter.py

@@ -32,17 +32,19 @@ FilterCoefsType = typing.TypeVar("FilterCoefsType", BACoeffs, SOSCoeffs)
 
 
 def _normalize_coefs(
-    coefs: FilterCoefficients | tuple[npt.NDArray, npt.NDArray] | npt.NDArray,
-) -> tuple[str, tuple[npt.NDArray, ...]]:
+    coefs: FilterCoefficients | tuple[npt.NDArray, npt.NDArray] | npt.NDArray | None,
+) -> tuple[str, tuple[npt.NDArray, ...] | None]:
     coef_type = "ba"
     if coefs is not None:
         # scipy.signal functions called with first arg `*coefs`.
         # Make sure we have a tuple of coefficients.
-        if isinstance(coefs, npt.NDArray):
+        if isinstance(coefs, np.ndarray):
             coef_type = "sos"
             coefs = (coefs,)  # sos funcs just want a single ndarray.
         elif isinstance(coefs, FilterCoefficients):
-            coefs = (FilterCoefficients.b, FilterCoefficients.a)
+            coefs = (coefs.b, coefs.a)
+        elif not isinstance(coefs, tuple):
+            coefs = (coefs,)
     return coef_type, coefs
 
 
@@ -91,16 +93,20 @@ class FilterTransformer(
         axis = message.dims[0] if self.settings.axis is None else self.settings.axis
         axis_idx = message.get_axis_idx(axis)
         n_tail = message.data.ndim - axis_idx - 1
-        coefs = (
-            (self.settings.coefs,)
-            if self.settings.coefs is not None
-            and not isinstance(self.settings.coefs, tuple)
-            else self.settings.coefs
-        )
-        zi_func = {"ba": scipy.signal.lfilter_zi, "sos": scipy.signal.sosfilt_zi}[
-            self.settings.coef_type
-        ]
-        zi = zi_func(*coefs)
+        _, coefs = _normalize_coefs(self.settings.coefs)
+
+        if self.settings.coef_type == "ba":
+            b, a = coefs
+            if len(a) == 1 or np.allclose(a[1:], 0):
+                # For FIR filters, use lfiltic with zero initial conditions
+                zi = scipy.signal.lfiltic(b, a, [])
+            else:
+                # For IIR filters...
+                zi = scipy.signal.lfilter_zi(b, a)
+        else:
+            # For second-order sections (SOS) filters, use sosfilt_zi
+            zi = scipy.signal.sosfilt_zi(*coefs)
+
         zi_expand = (None,) * axis_idx + (slice(None),) + (None,) * n_tail
         n_tile = (
             message.data.shape[:axis_idx] + (1,) + message.data.shape[axis_idx + 1 :]
@@ -166,12 +172,7 @@ class FilterTransformer(
         if message.data.size > 0:
             axis = message.dims[0] if self.settings.axis is None else self.settings.axis
             axis_idx = message.get_axis_idx(axis)
-            coefs = (
-                (self.settings.coefs,)
-                if self.settings.coefs is not None
-                and not isinstance(self.settings.coefs, tuple)
-                else self.settings.coefs
-            )
+            _, coefs = _normalize_coefs(self.settings.coefs)
             filt_func = {"ba": scipy.signal.lfilter, "sos": scipy.signal.sosfilt}[
                 self.settings.coef_type
             ]

ezmsg/sigproc/gaussiansmoothing.py

@@ -0,0 +1,93 @@
+from typing import Callable
+import warnings
+
+import numpy as np
+
+from .filter import (
+    FilterBaseSettings,
+    BACoeffs,
+    FilterByDesignTransformer,
+    BaseFilterByDesignTransformerUnit,
+)
+
+
+class GaussianSmoothingSettings(FilterBaseSettings):
+    sigma: float | None = 1.0
+    """
+    sigma : float
+        Standard deviation of the Gaussian kernel.
+    """
+
+    width: int | None = 4
+    """
+    width : int
+        Number of standard deviations covered by the kernel window if kernel_size is not provided.
+    """
+
+    kernel_size: int | None = None
+    """
+    kernel_size : int | None
+        Length of the kernel in samples. If provided, overrides automatic calculation.
+    """
+
+
+def gaussian_smoothing_filter_design(
+    sigma: float = 1.0,
+    width: int = 4,
+    kernel_size: int | None = None,
+) -> BACoeffs | None:
+    # Parameter checks
+    if sigma <= 0:
+        raise ValueError(f"sigma must be positive. Received: {sigma}")
+
+    if width <= 0:
+        raise ValueError(f"width must be positive. Received: {width}")
+
+    if kernel_size is not None:
+        if kernel_size < 1:
+            raise ValueError(f"kernel_size must be >= 1. Received: {kernel_size}")
+    else:
+        kernel_size = int(2 * width * sigma + 1)
+
+    # Warn if kernel_size is smaller than recommended but don't fail
+    expected_kernel_size = int(2 * width * sigma + 1)
+    if kernel_size < expected_kernel_size:
+        ## TODO: Either add a warning or determine appropriate kernel size and raise an error
+        warnings.warn(
+            f"Provided kernel_size {kernel_size} is smaller than recommended "
+            f"size {expected_kernel_size} for sigma={sigma} and width={width}. "
+            "The kernel may be truncated."
+        )
+
+    from scipy.signal.windows import gaussian
+
+    b = gaussian(kernel_size, std=sigma)
+    b /= np.sum(b)  # Ensure normalization
+    a = np.array([1.0])
+
+    return b, a
+
+
+class GaussianSmoothingFilterTransformer(
+    FilterByDesignTransformer[GaussianSmoothingSettings, BACoeffs]
+):
+    def get_design_function(
+        self,
+    ) -> Callable[[float], BACoeffs]:
+        # Create a wrapper function that ignores fs parameter since gaussian smoothing doesn't need it
+        def design_wrapper(fs: float) -> BACoeffs:
+            return gaussian_smoothing_filter_design(
+                sigma=self.settings.sigma,
+                width=self.settings.width,
+                kernel_size=self.settings.kernel_size,
+            )
+
+        return design_wrapper
+
+
+class GaussianSmoothingFilter(
+    BaseFilterByDesignTransformerUnit[
+        GaussianSmoothingSettings, GaussianSmoothingFilterTransformer
+    ]
+):
+    SETTINGS = GaussianSmoothingSettings

ezmsg/sigproc/util/sparse.py

@@ -1,11 +1,13 @@
+import numpy as np
 import sparse
 
 
-def sliding_win_oneaxis(
+def sliding_win_oneaxis_old(
     s: sparse.SparseArray, nwin: int, axis: int, step: int = 1
 ) -> sparse.SparseArray:
     """
     Like `ezmsg.util.messages.axisarray.sliding_win_oneaxis` but for sparse arrays.
+    This approach is about 4x slower than the version that uses coordinate arithmetic below.
 
     Args:
         s: The input sparse array.
@@ -25,5 +27,97 @@ def sliding_win_oneaxis(
         full_slices[: axis + 1] + (sl,) + full_slices[axis + 2 :] for sl in targ_slices
     ]
     result = sparse.concatenate([s[_] for _ in full_slices], axis=axis)
-    # TODO: Profile this approach vs modifying coords only.
     return result
+
+
+def sliding_win_oneaxis(
+    s: sparse.SparseArray, nwin: int, axis: int, step: int = 1
+) -> sparse.SparseArray:
+    """
+    Generates a view-like sparse array using a sliding window of specified length along a specified axis.
+    Sparse analog of an optimized dense as_strided-based implementation with these properties:
+
+    - Accepts a single `nwin` and a single `axis`.
+    - Inserts a new 'win' axis immediately BEFORE the original target axis.
+      Output shape:
+        s.shape[:axis] + (W,) + (nwin,) + s.shape[axis+1:]
+      where W = s.shape[axis] - (nwin - 1).
+    - If `step > 1`, stepping is applied by slicing along the new windows axis (same observable behavior
+      as doing `slice_along_axis(result, slice(None, None, step), axis)` in the dense version).
+
+    Args:
+        s: Input sparse array (pydata/sparse COO-compatible).
+        nwin: Sliding window size (must be > 0).
+        axis: Axis of `s` along which the window slides (supports negative indexing).
+        step: Stride between windows. If > 1, applied by slicing the windows axis after construction.
+
+    Returns:
+        A sparse array with a new windows axis inserted before the original axis.
+
+    Notes:
+        - Mirrors the dense function’s known edge case: when nwin == shape[axis] + 1, W becomes 0 and
+          an empty windows axis is returned.
+        - Built by coordinate arithmetic; no per-window indexing or concatenation.
+    """
+    if -s.ndim <= axis < 0:
+        axis = s.ndim + axis
+    if not (0 <= axis < s.ndim):
+        raise ValueError(f"Invalid axis {axis} for array with {s.ndim} dimensions")
+    if nwin <= 0:
+        raise ValueError("nwin must be > 0")
+    dim = s.shape[axis]
+
+    last_win_start = dim - nwin
+    win_starts = list(range(0, last_win_start + 1, step))
+    n_win_out = len(win_starts)
+    if n_win_out <= 0:
+        # Return array with proper shape except empty along windows axis
+        return sparse.zeros(
+            s.shape[:axis] + (0,) + (nwin,) + s.shape[axis + 1 :], dtype=s.dtype
+        )
+
+    coo = s.asformat("coo")
+    coords = coo.coords  # shape: (ndim, nnz)
+    data = coo.data  # shape: (nnz,)
+    ia = coords[axis]  # indices along sliding axis, shape: (nnz,)
+
+    # We emit contributions for each offset o in [0, nwin-1].
+    # For a nonzero at index i, it contributes to window start w = i - o when 0 <= w < W.
+    out_coords_blocks = []
+    out_data_blocks = []
+
+    # Small speed/memory tweak: reuse dtypes and pre-allocate o-array once per loop.
+    idx_dtype = coords.dtype
+
+    for win_ix, win_start in enumerate(win_starts):
+        w = ia - win_start
+        # Valid window starts are those within [0, nwin]
+        mask = (w >= 0) & (w < nwin)
+        if not mask.any():
+            continue
+
+        sel = np.nonzero(mask)[0]
+        w_sel = w[sel]
+
+        # Build new coords with windows axis inserted at `axis` and the original axis
+        # becoming the next axis with fixed offset value `o`.
+        # Output ndim = s.ndim + 1
+        before = coords[:axis, sel]  # unchanged
+        after_other = coords[axis + 1 :, sel]  # dims after original axis
+        win_idx_row = np.full((1, sel.size), win_ix, dtype=idx_dtype)
+
+        new_coords = np.vstack([before, win_idx_row, w_sel[None, :], after_other])
+
+        out_coords_blocks.append(new_coords)
+        out_data_blocks.append(data[sel])
+
+    if not out_coords_blocks:
+        return sparse.zeros(
+            s.shape[:axis] + (n_win_out,) + (nwin,) + s.shape[axis + 1 :], dtype=s.dtype
+        )
+
+    out_coords = np.hstack(out_coords_blocks)
+    out_data = np.hstack(out_data_blocks)
+    out_shape = s.shape[:axis] + (n_win_out,) + (nwin,) + s.shape[axis + 1 :]
+
+    return sparse.COO(out_coords, out_data, shape=out_shape)

ezmsg_sigproc-2.2.0.dist-info/METADATA

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: ezmsg-sigproc
+Version: 2.2.0
+Summary: Timeseries signal processing implementations in ezmsg
+Author-email: Griffin Milsap <griffin.milsap@gmail.com>, Preston Peranich <pperanich@gmail.com>, Chadwick Boulay <chadwick.boulay@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Requires-Python: >=3.10.15
+Requires-Dist: array-api-compat>=1.11.1
+Requires-Dist: ezmsg>=3.6.0
+Requires-Dist: numba>=0.61.0
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: pywavelets>=1.6.0
+Requires-Dist: scipy>=1.13.1
+Requires-Dist: sparse>=0.15.4
+Description-Content-Type: text/markdown
+
+# ezmsg.sigproc
+
+## Overview
+
+ezmsg-sigproc offers timeseries signal‑processing primitives built atop the ezmsg message‑passing framework. Core dependencies include ezmsg, numpy, scipy, pywavelets, and sparse; the project itself is managed through hatchling and uses VCS hooks to populate __version__.py.
+
+## Installation
+
+Install the latest release from pypi with: `pip install ezmsg-sigproc` (or `uv add ...` or `poetry add ...`).
+
+You can install pre-release versions directly from GitHub:
+
+* Using `pip`: `pip install git+https://github.com/ezmsg-org/ezmsg-sigproc.git@dev`
+* Using `uv`: `uv add git+https://github.com/ezmsg-org/ezmsg-sigproc --branch dev`
+* Using `poetry`: `poetry add "git+https://github.com/ezmsg-org/ezmsg-sigproc.git@dev"`
+
+> See the [Development](#development) section below for installing with the intention of developing.
+
+## Source layout & key modules
+* All source resides under src/ezmsg/sigproc, which contains a suite of processors (for example, filter.py, spectrogram.py, spectrum.py, sampler.py) and math and util subpackages.
+* The framework’s backbone is base.py, defining standard protocols—Processor, Producer, Consumer, and Transformer—that enable both stateless and stateful processing chains.
+* Filtering is implemented in filter.py, providing settings dataclasses and a stateful transformer that applies supplied coefficients to incoming data.
+* Spectral analysis uses a composite spectrogram transformer chaining windowing, spectrum computation, and axis adjustments.
+
+## Operating styles: Standalone processors vs. ezmsg pipelines
+While each processor is designed to be assembled into an ezmsg pipeline, the components are also well‑suited for offline, ad‑hoc analysis. You can instantiate processors directly in scripts or notebooks for quick prototyping or to validate results from other code. The companion Unit wrappers, however, are meant for assembling processors into a full ezmsg pipeline.
+
+A fully defined ezmsg pipeline shines in online streaming scenarios where message routing, scheduling, and latency handling are crucial. Nevertheless, you can run the same pipeline offline—say, within a Jupyter notebook—if your analysis benefits from ezmsg’s structured execution model. Deciding between a standalone processor and a full pipeline comes down to the trade‑off between simplicity and the operational overhead of the pipeline:
+
+* Standalone processors: Low overhead, ideal for one‑off or exploratory offline tasks.
+* Pipeline + Unit wrappers: Additional setup cost but bring concurrency, standardized interfaces, and automatic message flow—useful when your offline experiment mirrors a live system or when you require fine‑grained pipeline behavior.
+
+## Documentation & tests
+* `docs/ProcessorsBase.md` details the processor hierarchy and generic type patterns, providing a solid foundation for custom components.
+* Unit tests (e.g., `tests/unit/test_sampler.py`) offer concrete examples of usage, showcasing sampler generation, windowing, and message handling.
+
+## Where to learn next
+* Study docs/ProcessorsBase.md to master the processor architecture.
+* Explore unit tests for hands‑on examples of composing processors and Units.
+* Review the ezmsg framework in pyproject.toml to understand the surrounding ecosystem.
+* Experiment with the code—try running processors standalone and then integrate them into a small pipeline to observe the trade‑offs firsthand.
+
+This approach equips newcomers to choose the right level of abstraction—raw processor, Unit wrapper, or full pipeline—based on the demands of their analysis or streaming application.
+
+## Development
+
+We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for development. It is not strictly required, but if you intend to contribute to ezmsg-sigproc then using `uv` will lead to the smoothest collaboration.
+
+1. Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) if not already installed.
+2. Fork ezmsg-sigproc and clone your fork to your local computer.
+3. Open a terminal and `cd` to the cloned folder.
+4. `uv sync` to create a .venv and install dependencies.
+5. `uv run pre-commit install` to install pre-commit hooks to do linting and formatting.
+6. Run the test suite before finalizing your edits: `uv run pytest tests`
+7. Make a PR against the `dev` branch of the main repo.

{ezmsg_sigproc-2.1.0.dist-info → ezmsg_sigproc-2.2.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ezmsg/sigproc/__init__.py,sha256=8K4IcOA3-pfzadoM6s2Sfg5460KlJUocGgyTJTJl96U,52
-ezmsg/sigproc/__version__.py,sha256=dseuoOPG9WZ1Ezr1SC3wS9_hczkX-b1NdE4TQPHFJso,511
+ezmsg/sigproc/__version__.py,sha256=wdFcRBeaWRZXknL-E8RTk9hV9M-OMto6dfJ90sc1i9A,511
 ezmsg/sigproc/activation.py,sha256=qWAhpbFBxSoqbGy4P9JKE5LY-5v8rQI1U81OvNxBG2Y,2820
 ezmsg/sigproc/adaptive_lattice_notch.py,sha256=3M65PrZpdgBlQtE7Ph4Gu2ISIyWw4j8Xxhm5PpSkLFw,9102
 ezmsg/sigproc/affinetransform.py,sha256=WU495KoDKZfHPS3Dumh65rgf639koNlfDIx_torIByg,8662
@@ -16,8 +16,9 @@ ezmsg/sigproc/downsample.py,sha256=0X6EwPZ_XTwA2-nx5w-2HmMZUEDFuGAYF5EmPSuuVj8,3
 ezmsg/sigproc/ewma.py,sha256=W_VS2MxiO1J7z2XS6rtnLnCEXxdRPQbMKtZduBwqTEQ,6369
 ezmsg/sigproc/ewmfilter.py,sha256=EPlocRdKORj575VV1YUzcNsVcq-pYgdEJ7_m9WfpVnY,4795
 ezmsg/sigproc/extract_axis.py,sha256=Gl8Hl_Ho2pPzchPjfseVHVRAqxj6eOvUQZlzfYRA7eI,1603
-ezmsg/sigproc/filter.py,sha256=i5adfND0NATrk2RewkWQ0C3RKRGiElr5AIB2eZE4Dr8,11225
+ezmsg/sigproc/filter.py,sha256=SfptCJFVxYL4sTNoMCsn2NYr66bo6ea1w9PqzWZmUBY,11299
 ezmsg/sigproc/filterbank.py,sha256=pJzv_G6chgWa1ARmRjMAMgt9eEGnA-ZbMSge4EWrcYY,13633
+ezmsg/sigproc/gaussiansmoothing.py,sha256=NaVezgNwdvp-kam1I_7lSID4Obi0UCxZshH7A2afaVg,2692
 ezmsg/sigproc/messages.py,sha256=y_twVPK7TxRj8ajmuSuBuxwvLTgyv9OF7Y7v9bw1tfs,926
 ezmsg/sigproc/quantize.py,sha256=VzaqE6PatibEjkk7XrGO-ubAXYurAed9FYOn4bcQZQk,2193
 ezmsg/sigproc/resample.py,sha256=XQzEbUq44qTx5tXX2QXd14hkMb7C3LXT3CqbC161X1M,11600
@@ -43,9 +44,9 @@ ezmsg/sigproc/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 ezmsg/sigproc/util/asio.py,sha256=PQew73hB1oRmp7pfTqx-c4uo1zqgjxvZcTZCROQrEP4,5270
 ezmsg/sigproc/util/message.py,sha256=l_b1b6bXX8N6VF9RbUELzsHs73cKkDURBdIr0lt3CY0,909
 ezmsg/sigproc/util/profile.py,sha256=KNJ_QkKelQHNEp2C8MhqzdhYydMNULc_NQq3ccMfzIk,5775
-ezmsg/sigproc/util/sparse.py,sha256=8Ke0jh3jRPi_TwIdLTwLdojQiaqPs6QV-Edqpx81VoI,1036
+ezmsg/sigproc/util/sparse.py,sha256=mE64p1tYb5A1shaRE1D-VnH-RshbLb8g8kXSXxnA-J4,4842
 ezmsg/sigproc/util/typeresolution.py,sha256=5R7xmG-F4CkdqQ5aoQnqM-htQb-VwAJl58jJgxtClys,3146
-ezmsg_sigproc-2.1.0.dist-info/METADATA,sha256=DuXuzu_YGIIldSiNwz9g72hu5x8JAHjxhGGsy5JXkS0,2479
-ezmsg_sigproc-2.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ezmsg_sigproc-2.1.0.dist-info/licenses/LICENSE.txt,sha256=seu0tKhhAMPCUgc1XpXGGaCxY1YaYvFJwqFuQZAl2go,1100
-ezmsg_sigproc-2.1.0.dist-info/RECORD,,
+ezmsg_sigproc-2.2.0.dist-info/METADATA,sha256=KfMyPnQipTaX6puyJxEaKu-JDT0tvbxLnhwKeEY_kKw,4977
+ezmsg_sigproc-2.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ezmsg_sigproc-2.2.0.dist-info/licenses/LICENSE.txt,sha256=seu0tKhhAMPCUgc1XpXGGaCxY1YaYvFJwqFuQZAl2go,1100
+ezmsg_sigproc-2.2.0.dist-info/RECORD,,

ezmsg_sigproc-2.1.0.dist-info/METADATA

@@ -1,62 +0,0 @@
-Metadata-Version: 2.4
-Name: ezmsg-sigproc
-Version: 2.1.0
-Summary: Timeseries signal processing implementations in ezmsg
-Author-email: Griffin Milsap <griffin.milsap@gmail.com>, Preston Peranich <pperanich@gmail.com>, Chadwick Boulay <chadwick.boulay@gmail.com>
-License-Expression: MIT
-License-File: LICENSE.txt
-Requires-Python: >=3.10.15
-Requires-Dist: array-api-compat>=1.11.1
-Requires-Dist: ezmsg>=3.6.0
-Requires-Dist: numba>=0.61.0
-Requires-Dist: numpy>=1.26.0
-Requires-Dist: pywavelets>=1.6.0
-Requires-Dist: scipy>=1.13.1
-Requires-Dist: sparse>=0.15.4
-Provides-Extra: test
-Requires-Dist: flake8>=7.1.1; extra == 'test'
-Requires-Dist: frozendict>=2.4.4; extra == 'test'
-Requires-Dist: pytest-asyncio>=0.24.0; extra == 'test'
-Requires-Dist: pytest-cov>=5.0.0; extra == 'test'
-Requires-Dist: pytest>=8.3.3; extra == 'test'
-Description-Content-Type: text/markdown
-
-# ezmsg.sigproc
-
-Timeseries signal processing implementations for ezmsg
-
-## Dependencies
-
-* `ezmsg`
-* `numpy`
-* `scipy`
-* `pywavelets`
-
-## Installation
-
-### Release
-
-Install the latest release from pypi with: `pip install ezmsg-sigproc` (or `uv add ...` or `poetry add ...`).
-
-### Development Version
-
-You can add the development version of `ezmsg-sigproc` to your project's dependencies in one of several ways.
-
-You can clone it and add its path to your project dependencies. You may wish to do this if you intend to edit `ezmsg-sigproc`. If so, please refer to the [Developers](#developers) section below.
-
-You can also add it directly from GitHub:
-
-* Using `pip`: `pip install git+https://github.com/ezmsg-org/ezmsg-sigproc.git@dev`
-* Using `poetry`: `poetry add "git+https://github.com/ezmsg-org/ezmsg-sigproc.git@dev"`
-* Using `uv`: `uv add git+https://github.com/ezmsg-org/ezmsg-sigproc --branch dev`
-
-## Developers
-
-We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for development. It is not strictly required, but if you intend to contribute to ezmsg-sigproc then using `uv` will lead to the smoothest collaboration.
-
-1. Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) if not already installed.
-2. Fork ezmsg-sigproc and clone your fork to your local computer.
-3. Open a terminal and `cd` to the cloned folder.
-4. `uv sync` to create a .venv and install dependencies.
-5. `uv run pre-commit install` to install pre-commit hooks to do linting and formatting.
-6. After editing code and making commits, Run the test suite before making a PR: `uv run pytest tests`