Release 0.0.21

.vscode/settings.json

@@ -58,6 +58,7 @@
         "downsampled",
         "downsamples",
         "downsampling",
+        "DTFT",
         "dtype",
         "exponentials",
         "exponentiating",
@@ -98,6 +99,7 @@
         "newaxis",
         "Nyquist",
         "overdamped",
+        "oversample",
         "oversampled",
         "packbits",
         "PAPR",

CITATION.cff

@@ -0,0 +1,8 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Hostetter"
+  given-names: "Matt"
+title: "sdr: A software-defined radio package for Python"
+date-released: 2023-07-09
+url: "https://github.com/mhostetter/sdr"

README.md

@@ -52,8 +52,8 @@ View all available classes and functions in the [API Reference](https://mhostett
   infinite impulse response (IIR) filters, polyphase interpolators, polyphase decimators, polyphase resamplers,
   polyphase channelizers, Farrow arbitrary resamplers, fractional delay FIR filters, FIR moving averagers,
   FIR differentiators, IIR integrators, IIR leaky integrators, complex mixing, real/complex conversion.
-- **Sequences**: Binary, Gray, Barker, Hadamard, Walsh, Kasami, Zadoff-Chu, m-sequences, Fibonacci LFSRs, Galois LFSRs,
-  LFSR synthesis.
+- **Sequences**: Binary, Gray, Barker, Hadamard, Walsh, Gold, Kasami, Zadoff-Chu, $m$-sequences, preferred pairs,
+  Fibonacci LFSRs, Galois LFSRs, LFSR synthesis.
 - **Coding**: Block interleavers, additive scramblers.
 - **Modulation**: Phase-shift keying (PSK), $\pi/M$ PSK, offset QPSK, continuous-phase modulation (CPM),
   minimum-shift keying (MSK), rectangular pulse shapes, half-sine pulse shapes, Gaussian pulse shapes,
@@ -72,12 +72,37 @@ View all available classes and functions in the [API Reference](https://mhostett
 - **Link budgets**: BSC, BEC, AWGN, and BI-AWGN channel capacity, Shannon's limit on $E_b/N_0$ and $S/N$,
   free-space path loss, antenna gain.
 - **Miscellaneous**: Packing and unpacking binary data, hexdump of binary data.
-- **Plotting**: Time-domain, raster, periodogram, spectrogram, constellation, symbol map, eye diagram, phase tree,
+- **Plotting**: Time-domain, raster, correlation, stem, discrete Fourier transform (DFT), discrete-time Fourier
+  transform (DTFT), periodogram, spectrogram, constellation, symbol map, eye diagram, phase tree,
   bit error rate (BER), symbol error rate (SER), probability of detection, receiver operating characteristic (ROC),
   detection PDFs, impulse response, step response, zeros/poles, magnitude response, phase response,
   phase delay, and group delay.
 
 ## Examples
 
-There are detailed examples published at <https://mhostetter.github.io/sdr/latest/examples/pulse-shapes/>.
+There are detailed examples published at <https://mhostetter.github.io/sdr/latest/examples/fir-filters/>.
 The Jupyter notebooks behind the examples are available for experimentation in `docs/examples/`.
+
+## Citation
+
+If this library was useful to you in your research, please cite us. Following the
+[GitHub citation standards](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files),
+here is the recommended citation.
+
+### BibTeX
+
+```bibtex
+@software{Hostetter_SDR_2023,
+    title = {{sdr: A software-defined radio package for Python}},
+    author = {Hostetter, Matt},
+    month = {7},
+    year = {2023},
+    url = {https://github.com/mhostetter/sdr},
+}
+```
+
+### APA
+
+```
+Hostetter, M. (2023). sdr: A software-defined radio package for Python [Computer software]. https://github.com/mhostetter/sdr
+```

docs/_static/extra.css

@@ -1,31 +1,31 @@
 /* Set the colors for the light theme */
-[data-md-color-scheme="default"] {
+/* [data-md-color-scheme="default"] {
   --md-primary-fg-color: #344FA1;
   --md-accent-fg-color: #4564C3;
-}
+} */
 
 /* Set the colors for the dark theme */
-[data-md-color-scheme="slate"] {
+/* [data-md-color-scheme="slate"] {
   --md-primary-fg-color: #EAA915;
   --md-accent-fg-color: #EEBA44;
-}
+} */
 
-[data-md-color-scheme="slate"] .md-header {
-  background-color: #344FA1;
+/* [data-md-color-scheme="slate"] .md-header {
+  background-color: var(--md-primary-fg-color);
 }
 
 [data-md-color-scheme="slate"] .md-tabs {
-  background-color: #344FA1;
-}
+  background-color: var(--md-primary-fg-color);
+} */
 
 /* @media screen and (max-width: 76.1875em) */
-.md-nav--primary .md-nav__title[for=__drawer] {
+/* .md-nav--primary .md-nav__title[for=__drawer] {
   background-color: #344FA1;
 }
 
 .md-source {
   background-color: #344FA1;
-}
+} */
 
 /* Fix line numbers in code blocks */
 .linenos {
@@ -35,7 +35,7 @@
 
 /* Override md-tab-set colors. */
 .md-typeset .tabbed-labels {
-  --md-accent-fg-color: var(--md-primary-fg-color);
+  --md-accent-fg-color: var(--md-typeset-a-color);
 }
 
 /* Modify Sphinx Immaterial python-apigen linkable parameter coloring. */

docs/api/plotting.rst

@@ -1,10 +1,10 @@
 Plotting
 ========
 
-Configuration
--------------
+Utility
+-------
 
-.. python-apigen-group:: plot-config
+.. python-apigen-group:: plot-utility
 
 Time-domain
 -----------

docs/conf.py

@@ -159,6 +159,8 @@
         {
             "media": "(prefers-color-scheme: light)",
             "scheme": "default",
+            "primary": "indigo",
+            "accent": "indigo",
             "toggle": {
                 "icon": "material/weather-night",
                 "name": "Switch to dark mode",
@@ -167,6 +169,8 @@
         {
             "media": "(prefers-color-scheme: dark)",
             "scheme": "slate",
+            "primary": "black",
+            "accent": "indigo",
             "toggle": {
                 "icon": "material/weather-sunny",
                 "name": "Switch to light mode",
@@ -199,8 +203,8 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
-    "scipy": ("http://docs.scipy.org/doc/scipy/reference/", None),
-    "matplotlib": ("http://matplotlib.sourceforge.net/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "matplotlib": ("https://matplotlib.org/stable/", None),
     "galois": ("https://mhostetter.github.io/galois/latest/", None),
 }
 

docs/index.rst

@@ -59,8 +59,8 @@ View all available classes and functions in the `API Reference <https://mhostett
   infinite impulse response (IIR) filters, polyphase interpolators, polyphase decimators, polyphase resamplers,
   polyphase channelizers, Farrow arbitrary resamplers, fractional delay FIR filters, FIR moving averagers,
   FIR differentiators, IIR integrators, IIR leaky integrators, complex mixing, real/complex conversion.
-- **Sequences**: Binary, Gray, Barker, Hadamard, Walsh, Kasami, Zadoff-Chu, m-sequences, Fibonacci LFSRs, Galois LFSRs,
-  LFSR synthesis.
+- **Sequences**: Binary, Gray, Barker, Hadamard, Walsh, Gold, Kasami, Zadoff-Chu, $m$-sequences, preferred pairs,
+  Fibonacci LFSRs, Galois LFSRs, LFSR synthesis.
 - **Coding**: Block interleavers, additive scramblers.
 - **Modulation**: Phase-shift keying (PSK), $\pi/M$ PSK, offset QPSK, continuous-phase modulation (CPM),
   minimum-shift keying (MSK), rectangular pulse shapes, half-sine pulse shapes, Gaussian pulse shapes,
@@ -79,11 +79,37 @@ View all available classes and functions in the `API Reference <https://mhostett
 - **Link budgets**: BSC, BEC, AWGN, and BI-AWGN channel capacity, Shannon's limit on $E_b/N_0$ and $S/N$,
   free-space path loss, antenna gain.
 - **Miscellaneous**: Packing and unpacking binary data, hexdump of binary data.
-- **Plotting**: Time-domain, raster, periodogram, spectrogram, constellation, symbol map, eye diagram, phase tree,
+- **Plotting**: Time-domain, raster, correlation, stem, discrete Fourier transform (DFT), discrete-time Fourier
+  transform (DTFT), periodogram, spectrogram, constellation, symbol map, eye diagram, phase tree,
   bit error rate (BER), symbol error rate (SER), probability of detection, receiver operating characteristic (ROC),
   detection PDFs, impulse response, step response, zeros/poles, magnitude response, phase response,
   phase delay, and group delay.
 
+Citation
+--------
+
+If this library was useful to you in your research, please cite us. Following the `GitHub citation standards <https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files>`_, here is the recommended citation.
+
+.. md-tab-set::
+
+   .. md-tab-item:: BibTeX
+
+      .. code-block:: latex
+
+         @software{Hostetter_SDR_2023,
+            title = {{sdr: A software-defined radio package for Python}},
+            author = {Hostetter, Matt},
+            month = {7},
+            year = {2023},
+            url = {https://github.com/mhostetter/sdr},
+         }
+
+   .. md-tab-item:: APA
+
+      .. code-block:: text
+
+         Hostetter, M. (2023). sdr: A software-defined radio package for Python [Computer software]. https://github.com/mhostetter/sdr
+
 .. toctree::
    :caption: Examples
    :hidden:

docs/release-notes/v0.0.md

@@ -4,6 +4,29 @@ tocdepth: 2
 
 # v0.0
 
+## v0.0.21
+
+*Released June 15, 2024*
+
+### Changes
+
+- Added Gold codes in `sdr.gold_code()`.
+- Added calculation of primitive polynomials that generate preferred pair $m$-sequences in `sdr.preferred_pairs()`.
+- Added check if two primitive polynomials form a preferred pair in `sdr.is_preferred_pair()`.
+- Added plot of the discrete Fourier transform (DFT) in `sdr.plot.dft()`.
+- Added plot of the discrete-time Fourier transform (DTFT) in `sdr.plot.dtft()`.
+- Added plot of periodic and non-periodic auto- and cross-correlations (PACF, ACF, PCCF, and CCF) in
+  `sdr.plot.correlation()`.
+- Added general-purpose stem plot, styled like MATLAB, in `sdr.plot.stem()`.
+- Added plot of Shannon's limit on $E_b/N_0$ in `sdr.plot.shannon_limit_ebn0()`.
+- Added support for `python -OO` optimization.
+- Increased required `galois` version to `v0.3.9`.
+
+### Contributors
+
+- Justin Charlong ([@jcharlong](https://github.com/jcharlong))
+- Matt Hostetter ([@mhostetter](https://github.com/mhostetter))
+
 ## v0.0.20
 
 *Released June 9, 2024*

pyproject.toml

@@ -48,7 +48,7 @@ dependencies = [
     "numba",                      # Use galois's version limitation
     "scipy",
     "matplotlib",
-    "galois == 0.3.8",            # Exact match required because of use of internals
+    "galois == 0.3.9",            # Exact match required because of use of internals
     "typing_extensions >= 4.0.0", # v4.0.0 is needed for use of Self (Python 3.11+) and Literal (Python 3.8+)
 ]
 dynamic = ["version"]
@@ -119,7 +119,7 @@ extend-select = [
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401", "F403"]
-"tests/*" = ["D"]
+"tests/*" = ["D", "D415"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"

src/sdr/_detection/_approximation.py

@@ -285,8 +285,8 @@ def shnidman(
                 ax[i].semilogx(p_fa, sdr.shnidman(p_d, p_fa, n_nc=n_nc, swerling=4), label=4)
                 ax[i].legend(title="Swerling")
                 ax[i].set_xlabel("Probability of false alarm, $P_{fa}$")
-                ax[i].set_ylabel("Minimum required input SNR (dB)")
-                ax[i].set_title(f"$N_{{nc}}={n_nc}$")
+                ax[i].set_ylabel("Minimum required input SNR (dB), $\gamma$")
+                ax[i].set_title(f"$N_{{nc}} = {n_nc}$")
             @savefig sdr_shnidman_1.png
             fig.suptitle("Minimum required SNR across Swerling target models");
 

src/sdr/_helper.py

@@ -43,6 +43,8 @@ def extend_docstring(method, replace=None, docstring=""):
 
     def decorator(obj):
         parent_docstring = getattr(method, "__doc__", "")
+        if parent_docstring is None:
+            return obj
         for from_str, to_str in replace.items():
             parent_docstring = parent_docstring.replace(from_str, to_str)
         obj.__doc__ = parent_docstring + "\n" + docstring

src/sdr/_sequence/__init__.py

@@ -4,5 +4,5 @@
 
 from ._correlation import *
 from ._lfsr import *
-from ._maximal import *
+from ._maximum import *
 from ._symbol_mapping import *