PyChOpMarg 3.1.0__tar.gz → 3.1.2__tar.gz

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: PyChOpMarg
-Version: 3.1.0
+Version: 3.1.2
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3
@@ -34,6 +34,7 @@ Requires-Dist: click
 Requires-Dist: numpy
 Requires-Dist: scikit-rf>=0.29
 Requires-Dist: typing_extensions
+Dynamic: license-file
 
 # PyChOpMarg
 

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "PyChOpMarg"
 description = "Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A."
-version = "3.1.0"
+version = "3.1.2"
 authors = [{name = "David Banas", email = "capn.freako@gmail.com"}]
 urls = { documentation = "https://pychopmarg.readthedocs.io/en/latest/"}
 readme = "README.md"

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/PyChOpMarg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: PyChOpMarg
-Version: 3.1.0
+Version: 3.1.2
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3
@@ -34,6 +34,7 @@ Requires-Dist: click
 Requires-Dist: numpy
 Requires-Dist: scikit-rf>=0.29
 Requires-Dist: typing_extensions
+Dynamic: license-file
 
 # PyChOpMarg
 

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/PyChOpMarg.egg-info/SOURCES.txt

@@ -17,6 +17,7 @@ src/pychopmarg/matlab.py
 src/pychopmarg/noise.py
 src/pychopmarg/optimize.py
 src/pychopmarg/plot.py
+src/pychopmarg/py.typed
 src/pychopmarg/config/__init__.py
 src/pychopmarg/config/ieee_8023by.py
 src/pychopmarg/config/ieee_8023dj.py
@@ -24,5 +25,6 @@ src/pychopmarg/config/template.py
 src/pychopmarg/utility/__init__.py
 src/pychopmarg/utility/filter.py
 src/pychopmarg/utility/general.py
+src/pychopmarg/utility/jupyter.py
 src/pychopmarg/utility/probability.py
 src/pychopmarg/utility/sparams.py

pychopmarg-3.1.2/src/pychopmarg/cli.py

@@ -0,0 +1,74 @@
+"""
+Main Entry Point for PyChOpMarg when using the CLI.
+
+Original author: David Banas <capn.freako@gmail.com>
+
+Original date:   March 25, 2024
+
+Copyright (c) 2024 David Banas; all rights reserved World wide.
+"""
+
+from pathlib import Path
+from typing  import Optional
+
+import click  # type: ignore
+
+from pychopmarg import __version__
+# from pychopmarg.com import COM
+from pychopmarg.utility.jupyter import execute_notebook, convert_notebook_to_html
+
+
+# ToDo: Activate when new `PyChOpMargUI` package is ready.
+# @click.group(invoke_without_command=True, context_settings=dict(help_option_names=["-h", "--help"]))
+@click.group(invoke_without_command=False, context_settings=dict(help_option_names=["-h", "--help"]))
+@click.pass_context
+@click.version_option(version=__version__)
+def cli(ctx):
+    """
+    PyChOpMarg command line interface.
+    """
+
+    if ctx.invoked_subcommand is None:  # No sub-command like `sim` given open the GUI like default.
+        # theCOM = COM()
+
+        # # Show the GUI.
+        # theCOM.configure_traits(view=traits_view)
+        raise RuntimeError("Sorry, the PyChOpMarg GUI is currently non-functional.")
+
+
+# @cli.command(context_settings=dict(help_option_names=["-h", "--help"]))
+# @click.argument("config-file", type=click.Path(exists=True))
+# @click.option("--results", "-r", type=click.Path(), help="Override the results filename.")
+# def run(config_file, results):
+#     """
+#     Run a COM calculation without opening the GUI.
+
+#     Will load the CONFIG_FILE from the given filepath, run the
+#     COM calculation and then save the results into a file with the same name
+#     but a different extension as the configuration file.
+#     """
+#     theCOM = COM()
+#     theCOM.load_configuration(config_file)
+#     theCOM.simulate(initial_run=True, update_plots=True)
+#     if not results:
+#         results = Path(config_file).with_suffix(".pychopmarg_results")
+#     theCOM.save_results(results)
+
+
+@cli.command(context_settings=dict(help_option_names=["-h", "--help"]))
+@click.argument("notebook-file", type=click.Path(exists=True))
+def run_notebook(notebook_file: Path):
+    """
+    Run a Jupyter notebook in place w/o opening a browser tab.
+    """
+    execute_notebook(notebook_file)
+
+@cli.command(context_settings=dict(help_option_names=["-h", "--help"]))
+@click.argument("notebook-file", type=click.Path(exists=True))
+@click.option("--out-file", "-o", type=click.Path(), help="Override the output filename.")
+def convert_notebook(notebook_file: Path, out_file: Optional[Path] = None):
+    """
+    Convert a Jupyter notebook to an HTML report, omitting all code.
+    """
+    convert_notebook_to_html(Path(notebook_file), results_path=out_file)
+    

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/com.py

@@ -139,8 +139,8 @@ class COM():  # pylint: disable=too-many-instance-attributes,too-many-public-met
 
         # Create the system time & frequency vectors.
         fb = com_params.fb * 1e9
-        # fstep = com_params.fstep * 1e9
-        fstep = 50e6               # Dramatically improves performance.
+        fstep = com_params.fstep * 1e9
+        # fstep = 50e6               # Dramatically improves performance.
         # - time
         tmax = 1 / fstep           # Just enough to cover one full cycle of the fundamental.
         ui = 1 / fb

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/common.py

@@ -27,8 +27,9 @@ COMFiles: TypeAlias = str | list[str]
 COMNtwk: TypeAlias = tuple[rf.Network, str]
 COMChnl: TypeAlias = tuple[COMNtwk, Cvec]
 
-PI: float = np.pi
-TWOPI: float = 2 * np.pi
+# PI    = np.pi  # Making autodoc barf.
+PI    = 3.14159     #: Value of Pi
+TWOPI = 2.0 * PI    #: 2 * Pi
 
 ChnlGrpName: TypeAlias = str  # channel group name
 ChnlSetName: TypeAlias = str  # channel set name (the stem of the thru channel s4p file name)

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/config/ieee_8023by.py

@@ -14,7 +14,7 @@ from pychopmarg.config.template import COMParams
 fB = 25 * 66. / 64.
 
 IEEE_8023by = COMParams(
-    fB, 0.01, 40e9, 2, 32, 1e-5, 0.010, 1.0, 0.4, 0.4, 0.6, 50,
+    fB, 0.01, 2, 32, 1e-5, 0.010, 1.0, 0.4, 0.4, 0.6, 50,
     0.05, 27, 5.2e-8, 0.01,
     fB / 4, fB / 4, fB, 1.0, [float(-n) for n in range(13)], [0.],
     [-1.] * 6, [1.] * 6, [0.25] * 6, 0.,

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/config/ieee_8023dj.py

@@ -12,7 +12,7 @@ import numpy as np
 from pychopmarg.config.template import COMParams
 
 IEEE_8023dj = COMParams(
-    106.25, 0.01, 40e9, 4, 32, 2e-4, 0.004, 0.95, 0.413, 0.413, 0.45, 50,
+    106.25, 0.01, 4, 32, 2e-4, 0.004, 0.95, 0.413, 0.413, 0.45, 50,
     0.02, 33, 6.0e-9, 0.01,
     42.5, 42.5, 106.25, 1.328125, [-n for n in range(16)], [-n / 2 for n in range(11)],
     [-0.06, 0.0, -0.34, -0.2, 0.0, 0.0], [0.0, 0.12, 0.0, 0.0, 0.0, 0.0], [0.005, 0.005, 0.005, 0.005, 0.0, 0.0], 0.5,

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/config/template.py

@@ -13,14 +13,37 @@ import numpy as np
 from pychopmarg.common import Rvec
 
 
-@dataclass
+# @dataclass(frozen=True)  # We take COM parameters to be immutable.
+@dataclass()
 class COMParams():  # pylint: disable=too-many-instance-attributes
-    "Template definition for COM parameters."
+    """
+    Template definition for COM parameters.
+
+    ToDo:
+        1. Use `metadata` to provide units:
+
+            .. code-block:: python
+
+                @dataclass
+                class Product:
+                    name: str
+                    price: float = field(metadata={"unit": "USD"})
+
+        2. Is there a `helptext` field available in `metadata`?
+
+        3. If we ever want to exclude some fields from comparison operations:
+
+            .. code-block:: python
+
+                @dataclass
+                class CustomTask:
+                    name: str
+                    priority: int = field(compare=False)
+    """
 
     # General
     fb: float                   # (GBaud)
     fstep: float                # (GHz)
-    fmax: float                 # (Hz)
     L: int                      # modulation levels
     M: int                      # samples per UI
     DER_0: float                # detector error ratio

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/excel.py

@@ -261,7 +261,6 @@ def get_com_params(cfg_file: Path) -> COMParams:  # noqa=E501 pylint: disable=to
     rslt = COMParams(
         com_params_dict["fb"],
         com_params_dict["fstep"],
-        com_params_dict["fmax"],
         com_params_dict["L"],
         com_params_dict["M"],
         com_params_dict["DER_0"],

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/noise.py

@@ -91,9 +91,7 @@ class NoiseCalc():  # pylint: disable=too-many-instance-attributes
             ValueError: Unless `f` is uniformly sampled.
 
         Notes:
-            1. No assumption is made, re: any linkage between `t` and `f`.
-            2. The transfer functions are assumed to contain only positive frequency values.
-            3. `f` may begin at zero, but is not required to.
+            1. The transfer functions are assumed to contain only positive frequency values.
 
         ToDo:
             1. Consider defining a data class to hold the initialization data.
@@ -122,10 +120,10 @@ class NoiseCalc():  # pylint: disable=too-many-instance-attributes
         assert f[1] == f0, ValueError(
             f"The second element of `f` ({f[1]}) must be the fundamental frequency implied by the time vector ({f0})!")
         fs = 1 / t[1]
-        assert f[-1] == fs / 2, ValueError(
+        assert (f[-1] - fs / 2) < eps, ValueError(
             f"The last element of `f` ({f[-1]}) must be half the sampling frequency ({fs})!")
         dfs = diff(f)
-        assert all(dfs == dfs[0]), ValueError(
+        assert all((dfs - dfs[0]) < eps), ValueError(
             "The frequency vector, `f`, must be uniformly sampled!")
 
         super().__init__()
@@ -267,7 +265,7 @@ class NoiseCalc():  # pylint: disable=too-many-instance-attributes
         nUI = int(len(dV) / nspui)
         hJ = mean(reshape(concatenate((dV[(ts_ix - 1) % nspui::nspui][:nUI],
                                        dV[(ts_ix    ) % nspui::nspui][:nUI])),  # noqa=E202
-                          shape=(2, nUI)),
+                          (2, nUI)),
                   axis=0) / t[1]
 
         return varX * (self.Add**2 + self.sigma_Rj**2) * abs(rfft(hJ) * Tb)**2 * Tb  # i.e. - / fB
@@ -278,7 +276,11 @@ class NoiseCalc():  # pylint: disable=too-many-instance-attributes
         Sxn = sum(array(list(map(self.Sxn, self.agg_pulse_resps))), axis=0)
         Stn = self.Stn()
         Sjn = self.Sjn
-        min_len = min(len(Srn), len(Sxn), len(Stn), len(Sjn))
-        Sn = Srn[:min_len] + Sxn[:min_len] + Stn[:min_len] + Sjn[:min_len]
+        if self.agg_pulse_resps:
+            min_len = min(len(Srn), len(Sxn), len(Stn), len(Sjn))
+            Sn = Srn[:min_len] + Sxn[:min_len] + Stn[:min_len] + Sjn[:min_len]
+        else:
+            min_len = min(len(Srn), len(Stn), len(Sjn))
+            Sn = Srn[:min_len] + Stn[:min_len] + Sjn[:min_len]
         # i.e. - `* fB`, which when combined w/ the implicit `1/N` of `irfft()` yields `* df`.
         return irfft(Sn) / self.Tb

{pychopmarg-3.1.0 → pychopmarg-3.1.2}/src/pychopmarg/optimize.py

@@ -13,7 +13,7 @@ from typing     import Any, Optional
 import numpy as np
 # pylint: disable=redefined-builtin
 from numpy import (
-    argmax, array, array_equal, concatenate, dot,
+    argmax, array, array_equal, concatenate, dot, identity,
     log10, maximum, minimum, ones, pad, sqrt, sum, vectorize, where, zeros)
 from numpy.linalg import lstsq
 from scipy.linalg import convolution_matrix, solve, toeplitz
@@ -309,9 +309,20 @@ def mmse(  # pylint: disable=too-many-arguments,too-many-positional-arguments,to
             Hb = H[d + 1: d + 1 + Nb]
             Rn = theNoiseCalc.Rn()[:Nw]
             R = H.T @ H + toeplitz(Rn) / varX
-            A = concatenate((concatenate(( R, -Hb.T,         -h0.reshape((Nw, 1))), axis=1),  # noqa=E201
-                             concatenate((-Hb, ones((Nb, 1)), zeros((Nb, 1))),      axis=1),
-                             concatenate(( h0, zeros(2))).reshape((1, Nw + 2))))              # noqa=E201
+            Ib = identity(Nb)
+            zb = zeros(Nb)
+            try:  # FixMe: The following breaks when `Nb` /= 1!
+                A = concatenate((concatenate(( R, -Hb.T, -h0.reshape((Nw, 1))), axis=1),  # noqa=E201
+                                 concatenate((-Hb, Ib,   zeros((Nb, 1))),       axis=1),
+                                 concatenate(( h0, zb,   zeros(1))).reshape((1, Nw + Nb + 1))))    # noqa=E201
+            except ValueError as err:
+                print(f"R.shape: {R.shape}", flush=True)
+                print(f"Hb.shape: {Hb.shape}", flush=True)
+                print(f"Nw: {Nw}", flush=True)
+                print(f"Nb: {Nb}", flush=True)
+                print(f"h0.reshape((Nw, 1)).shape: {h0.reshape((Nw, 1)).shape}", flush=True)
+                print(f"concatenate(( h0, zb,   zeros(1))).reshape((1, Nw + Nb + 1)).shape: {concatenate(( h0, zb,   zeros(1))).reshape((1, Nw + Nb + 1)).shape}", flush=True)
+                raise
             y = concatenate((h0, zeros(Nb), ones(1)))
             x = solve(A, y)
             w = x[:Nw]

pychopmarg-3.1.2/src/pychopmarg/utility/jupyter.py

@@ -0,0 +1,52 @@
+"""
+Jupyter utilities for PyChOpMarg.
+
+Original author: David Banas <capn.freako@gmail.com>
+
+Original date:   January 23, 2025
+
+Copyright (c) 2025 David Banas; all rights reserved World wide.
+"""
+
+import click                        # type: ignore
+import os
+from   pathlib      import Path
+import subprocess
+from typing         import Optional
+
+
+def execute_notebook(notebook_path: Path) -> None:
+    """
+    Executes a Jupyter notebook.
+
+    Args:
+        notebook_path: Path to the notebook.
+    """
+
+    if not os.path.exists(notebook_path):
+        raise FileNotFoundError(f"The notebook {notebook_path} was not found!")
+    
+    subprocess.run([
+        'jupyter', 'nbconvert', '--to', 'notebook', '--execute', '--inplace', notebook_path],
+        check=True)
+
+
+def convert_notebook_to_html(notebook_path: Path, results_path: Optional[Path] = None) -> None:
+    """
+    Converts a Jupyter notebook to an HTML file, excluding the input cells (code).
+
+    Args:
+        notebook_path: Path to the notebook.
+
+    Keyword Args:
+        results_path: Result file path.
+            Default: None (Use stem of ``notebook_path`` with ``.html`` suffix.)
+    """
+
+    if not os.path.exists(notebook_path):
+        raise FileNotFoundError(f"The notebook {notebook_path} was not found!")
+    
+    html_path = results_path or Path(notebook_path.name).with_suffix('.html')
+    subprocess.run(
+        ['jupyter', 'nbconvert', '--to', 'html', '--no-input', '--output', html_path, notebook_path],
+        check=True)

pychopmarg-3.1.0/src/pychopmarg/cli.py

@@ -1,51 +0,0 @@
-"""
-Main Entry Point for PyChOpMarg when using the CLI.
-
-Original author: David Banas <capn.freako@gmail.com>
-
-Original date:   March 25, 2024
-
-Copyright (c) 2024 David Banas; all rights reserved World wide.
-"""
-
-# from pathlib import Path
-
-# import click  # type: ignore
-
-# from pychopmarg import __version__
-# from pychopmarg.com import COM
-
-
-# ToDo: Activate when new `PyChOpMargUI` package is ready.
-# @click.group(invoke_without_command=True, context_settings=dict(help_option_names=["-h", "--help"]))
-# @click.pass_context
-# @click.version_option(version=__version__)
-# def cli(ctx):
-#     """
-#     PyChOpMargUI GUI.
-#     """
-
-#     if ctx.invoked_subcommand is None:  # No sub-command like `sim` given open the GUI like default.
-#         theCOM = COM()
-
-#         # Show the GUI.
-#         theCOM.configure_traits(view=traits_view)
-
-
-# @cli.command(context_settings=dict(help_option_names=["-h", "--help"]))
-# @click.argument("config-file", type=click.Path(exists=True))
-# @click.option("--results", "-r", type=click.Path(), help="Override the results filename.")
-# def run(config_file, results):
-#     """
-#     Run a COM calculation without opening the GUI.
-
-#     Will load the CONFIG_FILE from the given filepath, run the
-#     COM calculation and then save the results into a file with the same name
-#     but a different extension as the configuration file.
-#     """
-#     theCOM = COM()
-#     theCOM.load_configuration(config_file)
-#     theCOM.simulate(initial_run=True, update_plots=True)
-#     if not results:
-#         results = Path(config_file).with_suffix(".pychopmarg_results")
-#     theCOM.save_results(results)