Release 0.0.1

.github/workflows/release.yaml

@@ -14,42 +14,42 @@ jobs:
     name: Build the docs
     uses: ./.github/workflows/docs.yaml
 
-  # release:
-  #   name: Create GitHub release
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v3
-  #       with:
-  #         fetch-depth: 0  # Fetch all commits and tags
-  #         ref: ${{ github.ref }}
+  release:
+    name: Create GitHub release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Fetch all commits and tags
+          ref: ${{ github.ref }}
 
-  #     - name: Get current version
-  #       id: current
-  #       run: |
-  #         version=$(git tag --sort=-version:refname | head -n 1)
-  #         echo "version=${version}" >> $GITHUB_OUTPUT
+      - name: Get current version
+        id: current
+        run: |
+          version=$(git tag --sort=-version:refname | head -n 1)
+          echo "version=${version}" >> $GITHUB_OUTPUT
 
-  #     - name: Get previous version
-  #       id: previous
-  #       run: |
-  #         version=$(git tag --sort=-version:refname | head -n 2 | tail -1)
-  #         echo "version=${version}" >> $GITHUB_OUTPUT
+      - name: Get previous version
+        id: previous
+        run: |
+          version=$(git tag --sort=-version:refname | head -n 2 | tail -1)
+          echo "version=${version}" >> $GITHUB_OUTPUT
 
-  #     - name: Construct release notes
-  #       run: |
-  #         # cp docs/release-notes/${{ steps.current.outputs.version }}.md release_notes.md
-  #         echo -e "\n## Commits\n" > release_notes.md
-  #         git log --oneline ${{ steps.previous.outputs.version }}..${{ steps.current.outputs.version }} >> release_notes.md
+      - name: Construct release notes
+        run: |
+          # cp docs/release-notes/${{ steps.current.outputs.version }}.md release_notes.md
+          echo -e "\n## Commits\n" > release_notes.md
+          git log --oneline ${{ steps.previous.outputs.version }}..${{ steps.current.outputs.version }} >> release_notes.md
 
-  #     - name: Create GitHub release
-  #       uses: actions/create-release@v1
-  #       env:
-  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  #       with:
-  #         tag_name: ${{ steps.current.outputs.version }}
-  #         release_name: galois ${{ steps.current.outputs.version }}
-  #         body_path: release_notes.md
-  #         draft: true
+      - name: Create GitHub release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.current.outputs.version }}
+          release_name: sdr ${{ steps.current.outputs.version }}
+          body_path: release_notes.md
+          draft: true
 
   publish:
     name: Publish on PyPI

.github/workflows/test.yaml

@@ -0,0 +1,178 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+      - 'release/*'
+  pull_request:
+    branches:
+      - main
+      - 'release/*'
+
+jobs:
+  wait-on-wheel:
+    name: Wait for wheel
+    runs-on: ubuntu-latest
+    steps:
+      - name: Wait on build.yaml to build the wheel
+        uses: lewagon/[email protected]
+        with:
+          # When triggered on a pull request, github.sha is a temporary merge commit for the PR. The wait
+          # action must wait on the SHA of the commit that triggered the workflow, which is the HEAD of the
+          # PR branch. https://github.com/lewagon/wait-on-check-action/issues/25#issuecomment-784773361
+          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
+          # NOTE: Fake ternary operator, see https://github.com/actions/runner/issues/409
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          check-name: 'Wheel'
+          allowed-conclusions: success
+          wait-interval: 10
+
+  test-coverage:
+    name: Coverage
+    needs: wait-on-wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Upgrade pip
+        run: python3 -m pip install --upgrade pip
+
+      - name: Download wheel artifact
+        uses: dawidd6/action-download-artifact@v2
+        with:
+          workflow: build.yaml
+          workflow_conclusion: success
+          commit: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
+          # NOTE: Fake ternary operator, see https://github.com/actions/runner/issues/409
+
+      # This is needed because Windows terminal cannot expand `pip install sdr-*.whl`
+      - name: Get wheel file name
+        uses: tj-actions/glob@v15
+        id: glob
+        with:
+          files: sdr-*.whl
+          working-directory: dist/
+
+      - name: Install the dev dependencies
+        run: python3 -m pip install -r requirements-dev.txt
+
+      - name: Install the `sdr` package wheel with upgraded dependencies
+        run: python3 -m pip install --upgrade dist/${{ steps.glob.outputs.paths }}
+
+      - name: Test with pytest
+        run: python3 -m pytest -n auto --cov=sdr --cov-report=xml tests/
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: false
+          verbose: true
+
+  # test-min:
+  #   name: Min
+  #   needs: wait-on-wheel
+  #   if: ${{ github.event_name == 'pull_request' }}
+  #   strategy:
+  #     matrix:
+  #       os: [ubuntu-latest, macos-latest, windows-latest]
+  #       python-version: [3.7, 3.8, 3.9, '3.10', 3.11]
+  #   runs-on: ${{ matrix.os }}
+  #   steps:
+  #     - uses: actions/checkout@v3
+
+  #     - name: Set up Python ${{ matrix.python-version }}
+  #       uses: actions/setup-python@v4
+  #       with:
+  #         python-version: ${{ matrix.python-version }}
+
+  #     - name: Upgrade pip
+  #       run: python3 -m pip install --upgrade pip
+
+  #     - name: Download wheel artifact
+  #       uses: dawidd6/action-download-artifact@v2
+  #       with:
+  #         workflow: build.yaml
+  #         workflow_conclusion: success
+  #         commit: ${{github.event.pull_request.head.sha}}
+
+  #     # This is needed because Windows terminal cannot expand `pip install sdr-*.whl`
+  #     - name: Get wheel file name
+  #       uses: tj-actions/glob@v15
+  #       id: glob
+  #       with:
+  #         files: sdr-*.whl
+  #         working-directory: dist/
+
+  #     - name: Install the dev dependencies
+  #       run: python3 -m pip install -r requirements-dev.txt
+
+  #     - name: Install minimum package dependencies
+  #       run: python3 -m pip install -r requirements-min.txt
+
+  #     - name: Install the `sdr` package wheel with minimum dependencies
+  #       run: python3 -m pip install dist/${{ steps.glob.outputs.paths }}
+
+  #     - name: Test with pytest
+  #       run: python3 -m pytest -n auto tests/
+
+  #     - name: Upload coverage report
+  #       uses: codecov/codecov-action@v3
+  #       with:
+  #         fail_ci_if_error: false
+  #         verbose: true
+
+  test-latest:
+    name: Latest
+    needs: wait-on-wheel
+    if: ${{ github.event_name == 'pull_request' }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.7, 3.8, 3.9, '3.10', 3.11]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Upgrade pip
+        run: python3 -m pip install --upgrade pip
+
+      - name: Download wheel artifact
+        uses: dawidd6/action-download-artifact@v2
+        with:
+          workflow: build.yaml
+          workflow_conclusion: success
+          commit: ${{github.event.pull_request.head.sha}}
+
+      # This is needed because Windows terminal cannot expand `pip install sdr-*.whl`
+      - name: Get wheel file name
+        uses: tj-actions/glob@v15
+        id: glob
+        with:
+          files: sdr-*.whl
+          working-directory: dist/
+
+      - name: Install the dev dependencies
+        run: python3 -m pip install -r requirements-dev.txt
+
+      - name: Install the `sdr` package wheel with upgraded dependencies
+        run: python3 -m pip install --upgrade dist/${{ steps.glob.outputs.paths }}
+
+      - name: Test with pytest
+        run: python3 -m pytest -n auto tests/
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: false
+          verbose: true

.vscode/settings.json

@@ -1,14 +1,14 @@
 {
     "python.testing.pytestArgs": [
         "-c=pyproject.toml",
-        "tests/"
     ],
     "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.codeActionsOnSave": {
             "source.organizeImports": true
@@ -17,5 +17,15 @@
     },
     "editor.rulers": [
         120
+    ],
+    "cSpell.words": [
+        "Baseband",
+        "downsampling",
+        "Feedforward",
+        "overdamped",
+        "resampler",
+        "resamplers",
+        "underdamped",
+        "upsampling"
     ]
 }

README.md

@@ -18,3 +18,35 @@
 </div>
 
 A Python package for software-defined radio.
+
+> Enjoying the library? Give us a :star: on [GitHub](https://github.com/mhostetter/sdr)!
+
+## Features
+
+- Filters:
+   - Infinite impulse response filter (`sdr.IIR`)
+- Arbitrary resamplers:
+   - Farrow resampler (`sdr.FarrowResampler`)
+- Signal generators:
+   - Numerically-controlled oscillator (`sdr.NCO`)
+   - Direct digital synthesizer (`sdr.DDS`)
+- Phase-locked loops:
+   - Loop filter (`sdr.LoopFilter`)
+   - Closed-loop PLL analysis (`sdr.ClosedLoopPLL`)
+
+## Documentation
+
+The documentation for `sdr` is located at https://mhostetter.github.io/sdr/latest/.
+
+## Install the package
+
+The latest version of `sdr` can be installed from [PyPI](https://pypi.org/project/sdr/) using `pip`.
+
+```console
+$ python3 -m pip install sdr
+```
+
+## Examples
+
+There are detailed examples published at https://mhostetter.github.io/sdr/latest/examples/iir-filter/.
+The Jupyter notebooks behind the examples are available for experimentation in `docs/examples/`.

docs/.gitignore

@@ -1,2 +1,3 @@
 api/
 build/
+jupyter_execute/

docs/api.rst

@@ -2,3 +2,18 @@
 
 sdr
 ===
+
+Filtering
+---------
+
+.. python-apigen-group:: filtering
+
+Resampling
+----------
+
+.. python-apigen-group:: resampling
+
+Phase/time-locked loops
+-----------------------
+
+.. python-apigen-group:: pll