Metadata-Version: 2.3
Name: ezmsg-sigproc
Version: 1.3.2
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.9
Requires-Dist: ezmsg>=3.5.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: pywavelets>=1.6.0
Requires-Dist: scipy>=1.13.1
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`
