Release 0.0.9

.github/workflows/lint.yaml

@@ -12,7 +12,7 @@ on:
 
 jobs:
   run-linter:
-    name: Lint
+    name: Ruff Lint
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -34,14 +34,11 @@ jobs:
       - name: Install the `sdr` package
         run: python3 -m pip install .
 
-      - name: Lint code with pylint
-        run: python3 -m pylint src/sdr/
-
-      # - name: Lint tests with pylint
-      #   run: python3 -m pylint tests/
+      - name: Lint with ruff
+        run: python3 -m ruff check --output-format=github .
 
   run-formatter:
-    name: Format
+    name: Ruff Format
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -60,5 +57,5 @@ jobs:
       - name: Install the `sdr` package
         run: python3 -m pip install .
 
-      - name: Format with black
-        run: python3 -m black . --check
+      - name: Format with ruff
+        run: python3 -m ruff format --check .

.gitignore

@@ -4,7 +4,7 @@ __pycache__/
 # .pytest_cache/
 # build/
 dist/
-# env/
+env/
 src/*.egg-info
 src/sdr/_version.py
 # .coverage

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.3.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-yaml
+  - id: check-toml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.1.4
+  hooks:
+  - id: ruff
+  - id: ruff-format

.vscode/settings.json

@@ -1,57 +1,93 @@
 {
+    "python.testing.pytestEnabled": true,
     "python.testing.pytestArgs": [
         "-c=pyproject.toml",
     ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true,
-    "python.linting.pylintEnabled": true,
-    "python.linting.enabled": true,
-    "python.formatting.provider": "none",
-    "editor.formatOnSave": true,
     "notebook.formatOnSave.enabled": true,
     "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.codeActionsOnSave": {
             "source.organizeImports": true
         },
-        "editor.defaultFormatter": "ms-python.black-formatter"
     },
+    "editor.formatOnSave": true,
     "editor.rulers": [
         120
     ],
     "cSpell.words": [
         "Albersheim",
+        "Alouini",
+        "arange",
+        "arcsin",
+        "astype",
+        "atleast",
         "awgn",
         "baseband",
+        "beamwidth",
+        "BPSK",
+        "colorbar",
         "correlator",
+        "cumsum",
         "downsample",
         "downsampled",
         "downsamples",
         "downsampling",
+        "dtype",
         "exponentials",
         "feedforward",
         "figsize",
+        "frombuffer",
+        "fspl",
         "hexdump",
+        "infty",
         "intersymbol",
+        "iscomplexobj",
+        "isrealobj",
+        "issubdtype",
+        "linestyle",
+        "linewidth",
         "lowpass",
+        "mathbb",
         "matplotlib",
+        "memoryless",
         "multirate",
+        "nanmax",
+        "ndarray",
+        "ndim",
+        "newaxis",
         "Nyquist",
         "overdamped",
+        "packbits",
+        "PAPR",
         "passband",
         "periodogram",
         "periodograms",
         "polyphase",
+        "Proakis",
         "pyplot",
         "QPSK",
         "resampler",
         "resamplers",
         "savefig",
         "scipy",
+        "semilogy",
+        "sidelobes",
         "sinc",
         "stopband",
+        "unaliased",
+        "uncoded",
         "underdamped",
+        "unpackbits",
         "upsampled",
         "upsamples",
-        "upsampling"
+        "upsampling",
+        "xlabel",
+        "xlim",
+        "ylabel",
+        "ylim",
+        "Zadoff",
+        "zorder"
     ]
-}
+}

README.md

@@ -24,7 +24,7 @@ in Python. The library relies on and is designed to be interoperable with NumPy,
 Performance is also very important. So, where possible, Numba is used to accelerate computationally-intensive
 functions.
 
-Additionally, the library aims to replicate relevant functionality from Matlab's Communications and
+Additionally, the library aims to replicate relevant functionality from MATLAB's Communications and
 DSP Toolboxes.
 
 We are progressively adding functionality to the library. If there is something you'd like to see included
@@ -50,19 +50,18 @@ View all available classes and functions in the [API Reference](https://mhostett
 
 - **Digital signal processing**: Finite impulse response (FIR) filters, infinite impulse response (IIR) filters,
   polyphase interpolator, polyphase decimator, polyphase resampler, Farrow arbitrary resampler,
-  complex mixing, real/complex conversion.
+  FIR differentiator, IIR integrator, complex mixing, real/complex conversion.
 - **Sequences**: Barker, Zadoff-Chu.
 - **Modulation**: Phase-shift keying (PSK), $\pi/M$ PSK, offset QPSK, rectangular pulse shape, half-sine pulse shape,
   raised cosine pulse shape, root raised cosine pulse shape, Gaussian pulse shape, binary and Gray symbol mapping,
   differential encoding.
-- **Synchronization**: Numerically-controlled oscillators (NCO), direct digital synthesizers (DDS), loop filters,
-  closed-loop PLL analysis.
+- **Synchronization**: Numerically-controlled oscillators (NCO), loop filters, closed-loop PLL analysis.
 - **Measurement**: Energy, power, voltage, bit/symbol error rate, error vector magnitude (EVM).
 - **Conversions**: Between linear units and decibels. Between $E_b/N_0$, $E_s/N_0$, and $S/N$.
 - **Simulation**: Binary symmetric channel (BSC), binary erasure channel (BEC), discrete memoryless channel (DMC),
   additive white Gaussian noise (AWGN), frequency offset, sample rate offset, IQ imbalance.
 - **Link budgets**: Channel capacities, free-space path loss, antenna gains.
-- **Data manipulation**: Packing and unpacking binary data, hexdumping binary data.
+- **Data manipulation**: Packing and unpacking binary data, hexdump of binary data.
 - **Plotting**: Time-domain, raster, periodogram, spectrogram, constellation, symbol map, eye diagram,
   bit error rate (BER), symbol error rate (SER), impulse response, step response, magnitude response, phase response,
   phase delay, group delay, and zeros/poles.

docs/.gitignore

@@ -1,4 +1,4 @@
 api/sdr.*
 build/
 jupyter_execute/
-savefig/
+savefig/

docs/_templates/base.html

@@ -14,4 +14,4 @@
 <a href="{{ '../' ~ base_url}}">
   <strong>Click here to go to latest.</strong>
 </a>
-{% endblock %}
+{% endblock %}

docs/api/conversions.rst

@@ -6,6 +6,11 @@ Decibels
 
 .. python-apigen-group:: conversions-decibels
 
+Ratios
+------
+
+.. python-apigen-group:: conversions-ratios
+
 From $E_b/N_0$
 --------------
 

docs/api/dsp.rst

@@ -13,10 +13,15 @@ Multirate filtering
 
 .. python-apigen-group:: dsp-multirate-filtering
 
-Resampling
-----------
+Arbitrary resampling
+--------------------
 
-.. python-apigen-group:: resampling
+.. python-apigen-group:: dsp-arbitrary-resampling
+
+Filtering applications
+----------------------
+
+.. python-apigen-group:: dsp-filtering-applications
 
 Correlation
 -----------

docs/conf.py

@@ -188,6 +188,7 @@
 nitpick_ignore = [
     ("py:class", "numpy.typing.ArrayLike"),  # Wish this would work
     ("py:class", "numpy.typing.DTypeLike"),  # Wish this would work
+    ("py:class", "numpy.typing.NDArray"),  # Wish this would work
 ]
 
 
@@ -215,6 +216,7 @@
 autodoc_type_aliases = {
     "npt.ArrayLike": "~numpy.typing.ArrayLike",
     "npt.DTypeLike": "~numpy.typing.DTypeLike",
+    "npt.NDArray": "~numpy.typing.NDArray",
 }
 
 ipython_execlines = [

docs/development/formatting.rst

@@ -0,0 +1,77 @@
+Formatting
+==========
+
+The :obj:`sdr` library uses `Ruff <https://docs.astral.sh/ruff/>`_ for static analysis, linting, and code
+formatting.
+
+Install
+-------
+
+First, `ruff` needs to be installed on your system. Easily install it by installing the development dependencies.
+
+.. code-block:: console
+
+   $ python3 -m pip install -r requirements-dev.txt
+
+Configuration
+-------------
+
+The `ruff` configuration is provided in `pyproject.toml`.
+
+.. literalinclude:: ../../pyproject.toml
+   :caption: pyproject.toml
+   :start-at: [tool.ruff]
+   :end-before: [tool.pytest.ini_options]
+   :language: toml
+
+Run the linter
+--------------
+
+Run the Ruff linter manually from the command line.
+
+.. code-block:: console
+
+   $ python3 -m ruff check .
+
+Run the formatter
+-----------------
+
+Run the Ruff formatter manually from the command line.
+
+.. code-block:: console
+
+   $ python3 -m ruff format --check .
+
+Pre-commit
+----------
+
+A `pre-commit` configuration file with various hooks is provided in `.pre-commit-config.yaml`.
+
+.. literalinclude:: ../../.pre-commit-config.yaml
+   :caption: .pre-commit-config.yaml
+   :language: yaml
+
+Enable `pre-commit` by installing the pre-commit hooks.
+
+.. code-block:: console
+
+   $ pre-commit install
+
+Run `pre-commit` on all files.
+
+.. code-block:: console
+
+   $ pre-commit run --all-files
+
+Disable `pre-commit` by uninstalling the pre-commit hooks.
+
+.. code-block:: console
+
+   $ pre-commit uninstall
+
+Run from VS Code
+----------------
+
+Install the `Ruff extension <https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff>`_ for VS Code.
+Included is a VS Code configuration file `.vscode/settings.json`.
+VS Code will run the linter and formatter as you view and edit files.