Add non_coherent_gain()

.github/workflows/build.yaml

@@ -20,10 +20,10 @@ jobs:
         with:
           fetch-depth: 0  # Fetch all commits and tags, needed for intermediate versions
 
-      - name: Set up Python 3.7
+      - name: Set up Python 3.8
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.8
 
       - name: Upgrade pip and other packaging tools
         run: python3 -m pip install --upgrade pip setuptools setuptools_scm wheel build twine

.github/workflows/lint.yaml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, '3.10', 3.11, 3.12]
+        python-version: [3.8, 3.9, '3.10', 3.11, 3.12]
     steps:
       - uses: actions/checkout@v3
 

.github/workflows/test.yaml

@@ -83,7 +83,7 @@ jobs:
   #   strategy:
   #     matrix:
   #       os: [ubuntu-latest, macos-latest, windows-latest]
-  #       python-version: [3.7, 3.8, 3.9, '3.10', 3.11, 3.12]
+  #       python-version: [3.8, 3.9, '3.10', 3.11, 3.12]
   #   runs-on: ${{ matrix.os }}
   #   steps:
   #     - uses: actions/checkout@v3
@@ -136,7 +136,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.7, 3.8, 3.9, '3.10', 3.11, 3.12]
+        python-version: [3.8, 3.9, '3.10', 3.11, 3.12]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3

.pre-commit-config.yaml

@@ -3,6 +3,7 @@ repos:
   rev: v2.3.0
   hooks:
   - id: check-added-large-files
+    args: ['--maxkb=1000']
   - id: check-yaml
   - id: check-toml
   - id: end-of-file-fixer

docs/_static/extra.css

@@ -61,3 +61,14 @@
 [data-md-color-scheme="slate"] img.no-invert {
   filter: none;
 }
+
+/* Fix ugly cell borders for Jupyter notebooks */
+div.cell_input.docutils.container {
+  border: transparent;
+  border-left-color: transparent;
+}
+
+div.cell_output.docutils.container>div {
+  border: transparent;
+  background: transparent;
+}

docs/api/detection.rst

@@ -6,6 +6,16 @@ Detectors
 
 .. python-apigen-group:: detection-detectors
 
+Coherent integration
+-------------------
+
+.. python-apigen-group:: detection-coherent-integration
+
+Non-coherent integration
+------------------------
+
+.. python-apigen-group:: detection-non-coherent-integration
+
 Theoretical limits
 ------------------
 

docs/api/link-budgets.rst

@@ -15,8 +15,3 @@ Antennas
 --------
 
 .. python-apigen-group:: link-budget-antennas
-
-Coherent integration
---------------------
-
-.. python-apigen-group:: link-budget-coherent-integration

docs/index.rst

@@ -87,6 +87,8 @@ View all available classes and functions in the `API Reference <https://mhostett
    examples/farrow-resampler.ipynb
    examples/psk.ipynb
    examples/phase-locked-loop.ipynb
+   examples/coherent-integration.ipynb
+   examples/non-coherent-integration.ipynb
 
 .. toctree::
    :caption: Development

pyproject.toml

@@ -32,7 +32,6 @@ classifiers = [
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -43,7 +42,7 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Typing :: Typed",
 ]
-requires-python = ">=3.7"
+requires-python = ">=3.8"
 dependencies = [
     "numpy",                      # Use galois's version limitation
     "numba",                      # Use galois's version limitation

src/sdr/_detection/__init__.py

@@ -1,6 +1,8 @@
 """
 A subpackage for various detection algorithms.
 """
+from ._coherent_integration import *
 from ._correlator import *
 from ._energy import *
+from ._non_coherent_integration import *
 from ._theory import *

src/sdr/_link_budget/_integration.py → src/sdr/_detection/_coherent_integration.py

@@ -1,5 +1,5 @@
 """
-A module containing functions related to coherent gain loss.
+A module containing functions related to coherent integration.
 """
 from __future__ import annotations
 
@@ -16,25 +16,28 @@ def coherent_gain(
     n_c: npt.ArrayLike,
 ) -> npt.NDArray[np.float64]:
     r"""
-    Computes the SNR improvement by coherently integrating $N_c$ samples.
+    Computes the SNR improvement by coherently integrating $N_C$ samples.
 
     Arguments:
-        n_c: The number of samples $N_c$ to coherently integrate.
+        n_c: The number of samples $N_C$ to coherently integrate.
 
     Returns:
-        The coherent gain $G_c$ in dB.
+        The coherent gain $G_C$ in dB.
 
     Notes:
-        $$y[m] = \sum_{n=0}^{N_c-1} x[m-n]$$
-        $$\text{SNR}_{y,\text{dB}} = \text{SNR}_{x,\text{dB}} + G_c$$
-        $$G_c = 10 \log_{10} N_c$$
+        $$y[m] = \sum_{n=0}^{N_C-1} x[m-n]$$
+        $$\text{SNR}_{y,\text{dB}} = \text{SNR}_{x,\text{dB}} + G_C$$
+        $$G_C = 10 \log_{10} N_C$$
 
     Examples:
+        See the :ref:`coherent-integration` example.
+
         Compute the coherent gain for various integration lengths.
 
         .. ipython:: python
 
             sdr.coherent_gain(1)
+            sdr.coherent_gain(2)
             sdr.coherent_gain(10)
             sdr.coherent_gain(20)
 
@@ -47,12 +50,12 @@ def coherent_gain(
             @savefig sdr_coherent_gain_1.png
             plt.figure(); \
             plt.semilogx(n_c, sdr.coherent_gain(n_c)); \
-            plt.xlabel("Number of samples, $N_c$"); \
-            plt.ylabel("Coherent gain (dB), $G_c$"); \
+            plt.xlabel("Number of samples, $N_C$"); \
+            plt.ylabel("Coherent gain (dB), $G_C$"); \
             plt.title("Coherent gain as a function of the number of integrated samples");
 
     Group:
-        link-budget-coherent-integration
+        detection-coherent-integration
     """
     n_c = np.asarray(n_c)
     if np.any(n_c < 1):
@@ -104,7 +107,7 @@ def coherent_gain_loss(
             plt.plot(f, sdr.coherent_gain_loss(0.5e-3, f), label="0.5 ms"); \
             plt.plot(f, sdr.coherent_gain_loss(1e-3, f), label="1 ms"); \
             plt.plot(f, sdr.coherent_gain_loss(2e-3, f), label="2 ms"); \
-            plt.legend(); \
+            plt.legend(title="Integration time"); \
             plt.ylim(-5, 55); \
             plt.xlabel("Frequency offset (Hz)"); \
             plt.ylabel("Coherent gain loss (dB)"); \
@@ -121,14 +124,14 @@ def coherent_gain_loss(
             plt.plot(t * 1e3, sdr.coherent_gain_loss(t, 100), label="100 Hz"); \
             plt.plot(t * 1e3, sdr.coherent_gain_loss(t, 200), label="200 Hz"); \
             plt.plot(t * 1e3, sdr.coherent_gain_loss(t, 400), label="400 Hz"); \
-            plt.legend(); \
+            plt.legend(title="Frequency offset"); \
             plt.ylim(-5, 55); \
             plt.xlabel("Integration time (ms)"); \
             plt.ylabel("Coherent gain loss (dB)"); \
             plt.title("Coherent gain loss for various frequency offsets");
 
     Group:
-        link-budget-coherent-integration
+        detection-coherent-integration
     """
     integration_time = np.asarray(integration_time)
     freq_offset = np.asarray(freq_offset)
@@ -210,7 +213,7 @@ def max_integration_time(
             plt.title("Maximum integration time for various frequency offsets");
 
     Group:
-        link-budget-coherent-integration
+        detection-coherent-integration
     """
     cgl = np.asarray(cgl)
     freq_offset = np.asarray(freq_offset)
@@ -305,7 +308,7 @@ def max_frequency_offset(
             plt.title("Maximum frequency offset for various integration times");
 
     Group:
-        link-budget-coherent-integration
+        detection-coherent-integration
     """
     cgl = np.asarray(cgl)
     integration_time = np.asarray(integration_time)