Plotting Additions and Small DSP Fixes

.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: CI
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Linting py${{ matrix.python-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: astral-sh/setup-uv@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        pyproject-file: ./pyproject.toml
+
+    - name: Install
+      run: |
+        uv python install ${{ matrix.python-version }}
+        uv sync --group dev --extra viz
+
+    - name: Lint Python Code
+      run: |
+        uv run ruff check
+
+    - name: Format Check Python Code
+      run: |
+        uv run ruff format --check
+
+  test:
+    runs-on: ${{ matrix.os }}
+    name: Unit Testing py${{ matrix.python-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        python-version: ${{ matrix.python-version }}
+        pyproject-file: ./pyproject.toml
+
+    - name: Install
+      run: |
+        uv python install ${{ matrix.python-version }}
+        uv sync --group dev --extra viz
+
+    - name: test
+      run: |
+        uv run pytest

.gitignore

@@ -3,3 +3,5 @@ __pycache__/
 venv/
 *.egg-info/
 dist/
+build/
+.vscode/

DEVELOPMENT.md

@@ -0,0 +1,15 @@
+# Developer notes
+
+## Environment Setup
+
+```bash
+uv sync --group dev --extra viz
+```
+
+## Dev Checks
+
+```bash
+uv run ruff check
+uv run ruff format --check
+uv run pytest
+```

README.md

@@ -8,7 +8,8 @@ The plan is to explore all of the following concepts in this repository:
 - Common RF Plots
   - Power Spectral Density (PSD) ✔️
   - Eye Diagram ✔️
-  - Constellation
+  - Constellation ✔️
+  - Phase-tree
   - Detection efficiency performance curve
 - Digital Signal Processing Concepts
   - S-domain

examples/irig_comparison.py

@@ -10,28 +10,32 @@
 from waveforms.cpm.multih import (
     MULTIH_IRIG_DENOM,
     MULTIH_IRIG_NUMER,
-    MultiHSymbolMapper,
     freq_pulse_multih_irig,
 )
 from waveforms.cpm.pcmfm import (
     PCMFM_DENOM,
     PCMFM_NUMER,
-    PCMFMSymbolMapper,
     freq_pulse_pcmfm,
 )
 from waveforms.cpm.soqpsk import (
     SOQPSK_DENOM,
     SOQPSK_NUMER,
-    SOQPSKPrecoder,
     freq_pulse_soqpsk_tg,
 )
+from waveforms.cpm.trellis.encoder import TrellisEncoder
+from waveforms.cpm.trellis.model import (
+    SimpleTrellis2,
+    SimpleTrellis4,
+    SOQPSKTrellis4x2DiffEncoded,
+)
+from waveforms.glfsr import PNSequence
+
 
 rng = np.random.Generator(np.random.PCG64())
 
-DATA_HEADER = b"\x1b\x1bHello World!"
-DATA_EXTRA = bytes(rng.integers(0, 0xFF, size=4000, endpoint=True, dtype=np.uint8))
-DATA_BUFFER = DATA_HEADER + DATA_EXTRA
-j = complex(0, 1)
+PN_DEGREE = 15
+DATA_GEN = PNSequence(PN_DEGREE)
+DATA_BUFFER = np.packbits(DATA_GEN.generate_sequence())
 
 
 if __name__ == "__main__":
@@ -46,21 +50,21 @@
     irig_waveforms = [
         (
             "PCM-FM",
-            PCMFMSymbolMapper(),
+            TrellisEncoder(SimpleTrellis2),
             PCMFM_NUMER / PCMFM_DENOM,
             freq_pulse_pcmfm(sps=sps, order=6),
             1,
         ),
         (
             "SOQPSK-TG",
-            SOQPSKPrecoder(),
+            TrellisEncoder(SOQPSKTrellis4x2DiffEncoded),
             SOQPSK_NUMER / SOQPSK_DENOM,
             freq_pulse_soqpsk_tg(sps=sps),
             1,
         ),
         (
             "Multi-h CPM",
-            MultiHSymbolMapper(),
+            TrellisEncoder(SimpleTrellis4),
             MULTIH_IRIG_NUMER / MULTIH_IRIG_DENOM,
             freq_pulse_multih_irig(sps=sps),
             2,
@@ -152,4 +156,4 @@
 
     fig_psd.tight_layout()
     fig_psd.savefig(Path(__file__).parent.parent / "images" / "irig106_waveform_comparison.png")
-    fig_psd.show()
+    plt.show()

examples/pcmfm_test.py

@@ -8,37 +8,27 @@
 
 from waveforms.cpm.helpers import normalize_cpm_filter
 from waveforms.cpm.modulate import cpm_modulate
-from waveforms.cpm.pcmfm import (
-    PCMFM_DENOM,
-    PCMFM_NUMER,
-    PCMFMSymbolMapper,
-    freq_pulse_pcmfm,
-)
+from waveforms.cpm.pcmfm import PCMFM_DENOM, PCMFM_NUMER
+from waveforms.cpm.trellis.encoder import TrellisEncoder
+from waveforms.cpm.trellis.model import SimpleTrellis2
+from waveforms.glfsr import PNSequence
+
 
 rng = np.random.Generator(np.random.PCG64())
 
-DATA_HEADER = b"\x1b\x1bHello World!"
-DATA_EXTRA = bytes(rng.integers(0, 0xFF, size=4000, endpoint=True, dtype=np.uint8))
-DATA_BUFFER = DATA_HEADER + DATA_EXTRA
-j = complex(0, 1)
+PN_DEGREE = 15
+DATA_GEN = PNSequence(PN_DEGREE)
+DATA_BUFFER = np.packbits(DATA_GEN.generate_sequence())
 
 
 if __name__ == "__main__":
     sps = 20
     fft_size = 2**10
     length = 3
     tau = np.linspace(0, length, num=length * sps)
-    bit_array = np.unpackbits(np.frombuffer(DATA_BUFFER, dtype=np.uint8))
+    bit_array = np.unpackbits(DATA_BUFFER)
 
-    irig_waveforms = [
-        (
-            "PCM-FM",
-            PCMFMSymbolMapper(),
-            PCMFM_NUMER / PCMFM_DENOM,
-            freq_pulse_pcmfm(sps=sps, order=4),
-        ),
-    ]
-    mapper = PCMFMSymbolMapper()
+    mapper = TrellisEncoder(SimpleTrellis2)
     symbols = mapper(bit_array)
     mod_index = PCMFM_NUMER / PCMFM_DENOM
 
@@ -114,4 +104,4 @@
 
     fig.tight_layout()
     fig.savefig(Path(__file__).parent.parent / "images" / "pcmfm_bessel_comparison.png")
-    fig.show()
+    plt.show()