Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.83 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.83 KB

Build status codecov License PyPI GitHub release (latest by date) GitHub commits since latest release (by date) PyPI - Python Version PyPI - Wheel GitHub top language DOI

mplsignal

Matplotlib extension for signal processing

Documentation can be found here.

mplsignal currently consists of four main parts:

  • plane_plots: various splane and zplane for plotting pole-zero diagrams
  • freq_plots: various freqs and freqz methods for plotting magnitude and phase responses of transfer functions
  • ticker: tickers and formatters suitable for freqs/freqz-plots
  • scipyplot: convenience functions that can be directly fed to scipy.signal.freqs and scipy.signal.freqz

Dependencies

mplsignal is only useful if you also have Matplotlib installed. In addition, it relies on adjustText to position the multiplicity numbers next to poles and zeros.

If SciPy is installed, mplsignal will use some functions to compute frequency responses etc, but mplsignal also has its own functions for this.

Installation

You can install using pip:

pip install mplsignal

Development Installation

pip install -e ".[dev]"

Citing

If you use mplsignal in your published work, please cite https://zenodo.org/record/7699762, e.g., using the BibTeX record.

Related work

In the meantime between starting working on mplsignal and finally getting around to make it public, zplane was released. This can do most things that mplsignal can do and a few more. However, the configurability is larger for mplsignal and the tickers and locators are unique features.