PyChOpMarg 0.1__tar.gz → 0.1.2__tar.gz

{PyChOpMarg-0.1 → PyChOpMarg-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyChOpMarg
-Version: 0.1
+Version: 0.1.2
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3

{PyChOpMarg-0.1 → PyChOpMarg-0.1.2}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "PyChOpMarg"
 description = "Python implementation of COM, as per IEEE 802.3-22 Annex 93A."
-version = "0.1"
+version = "0.1.2"
 authors = [{name = "David Banas", email = "capn.freako@gmail.com"}]
 # urls = { documentation = "https://github.com/capn-freako/PyBERT/wiki"}
 readme = "README.md"
@@ -40,7 +40,7 @@ classifiers=[
 ]
 
 [project.scripts]
-pychopmarg = "pychopmarg.com:cli"
+pychopmarg = "pychopmarg:cli"
 
 [tool.setuptools.packages.find]
 where = ["src"]

{PyChOpMarg-0.1 → PyChOpMarg-0.1.2}/src/PyChOpMarg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyChOpMarg
-Version: 0.1
+Version: 0.1.2
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3

{PyChOpMarg-0.1 → PyChOpMarg-0.1.2}/src/PyChOpMarg.egg-info/SOURCES.txt

@@ -8,6 +8,8 @@ src/PyChOpMarg.egg-info/entry_points.txt
 src/PyChOpMarg.egg-info/requires.txt
 src/PyChOpMarg.egg-info/top_level.txt
 src/pychopmarg/__init__.py
+src/pychopmarg/cli.py
 src/pychopmarg/com.py
 src/pychopmarg/common.py
-src/pychopmarg/utility.py
+src/pychopmarg/utility.py
+src/pychopmarg/view.py

PyChOpMarg-0.1.2/src/PyChOpMarg.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pychopmarg = pychopmarg:cli

PyChOpMarg-0.1.2/src/pychopmarg/__init__.py

@@ -0,0 +1,23 @@
+"""
+A Python implementation of COM, as per IEEE 802.3-22 Annex 93A.
+
+.. moduleauthor:: David Banas <capn.freako@gmail.com>
+
+Original Author: David Banas <capn.freako@gmail.com>
+
+Original Date:   29 February 2024
+
+Copyright (c) 2024 by David Banas; all rights reserved World wide.
+"""
+
+from importlib.metadata import version as _get_version
+
+# Set PEP396 version attribute
+try:
+    __version__ = _get_version("PyChOpMarg")
+except:
+    __version__ = "(dev)"
+
+__date__ = "March 25, 2024"
+__authors__ = "David Banas"
+__copy__ = "Copyright (c) 2024 David Banas"

PyChOpMarg-0.1.2/src/pychopmarg/cli.py

@@ -0,0 +1,50 @@
+"""
+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
+
+from pychopmarg import __version__
+from pychopmarg.view import traits_view
+from pychopmarg.com import COM
+
+@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):
+    """
+    PyChOpMarg 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)

{PyChOpMarg-0.1 → PyChOpMarg-0.1.2}/src/pychopmarg/com.py

@@ -155,6 +155,26 @@ class COM(HasTraits):
 
     # Reserved functions
 
+    def __init__(self):
+        """
+        Instance creation only! Must still initialize.
+
+        Notes:
+            1. In order to support multi-mode operation (i.e. - library, CLI, and GUI),
+                we have to separate instance *creation* from instance *initialization*.
+                Therefore, at this point you still need to call one of the 3 initializers:
+                    - `init_lib()`,
+                    - `init_cli()`, or
+                    - `init_gui()`.
+                (See their docstrings, below, for more detail.)
+        """
+
+        # Super-class initialization is ABSOLUTELY NECESSARY, in order
+        # to get all the Traits/UI machinery setup correctly.
+        super().__init__()
+
+        self.initialized = False
+
     def __call__(self, do_opt_eq=True, tx_taps: Rvec = None):
         """
         Calculate the COM value.
@@ -166,6 +186,8 @@ class COM(HasTraits):
                 Default: None
         """
 
+        assert self.initialized, RuntimeError(
+            "You must initialize the instance before you can call it!")
         assert self.opt_eq(do_opt_eq=do_opt_eq, tx_taps=tx_taps), RuntimeError(
             "EQ optimization failed!")
         self.gDC = self.rslts['gDC']
@@ -181,31 +203,31 @@ class COM(HasTraits):
         self.cursor_ix = cursor_ix
         return com
 
-    def __init__(self, params: COMParams, chnl_files: list[str], vic_chnl_ix: int,
-                 zp_sel: int = 1, num_ui: int = 100, gui: bool = True):
+    # Initializers
+
+    def init_lib(self, params: COMParams, chnl_files: list[str], vic_chnl_ix: int,
+                 zp_sel: int = 1, num_ui: int = 100):
         """
-        COM class initializer.
+        COM class initializer for use as a library.
 
         Args:
             params: COM configuration parameters for desired standard.
                 Note: Assumed immutable. ToDo: Can we encode this assumption, using type annotations?
             chnl_files: Touchstone file(s) representing channel, either:
-                1. 8 s4p files: [victim, ], or
+                1. N s4p files: [victim, N-1 aggressors], or
                 2. 1 s32p file, according to VITA 68.2 convention.
-            vic_chnl_ix: Victim channel index (from 1).
+            vic_chnl_ix: Victim channel index (from 1) for option 2.
 
         KeywordArgs:
             zp_sel: User selection of package T-line length option (from 1).
                 Default: 1
             num_ui: Number of unit intervals to include in system time vector.
                 Default: 100
-            gui: Set to `False` for script/CLI based usage.
-                Default: True
-        """
 
-        # Super-class initialization is ABSOLUTELY NECESSARY, in order
-        # to get all the Traits/UI machinery setup correctly.
-        super().__init__()
+        Notes:
+            1. Use this initializer when you want to import from *PyChOpMarg*
+                into a larger Python script and/or Jupyter notebook.
+        """
 
         # Set default parameter values, as necessary.
         if 'zc' not in params:
@@ -216,7 +238,7 @@ class COM(HasTraits):
         # Stash function parameters.
         self.params = params
         self.chnl_files = chnl_files
-        self.gui = gui
+        self.gui = False
 
         # Calculate intermediate variable values.
         self.rslts = {}
@@ -349,11 +371,11 @@ class COM(HasTraits):
         r0 = self.params['R0']
         zp = self.params['zp'][zp_opt - 1]
 
-        f_GHz  = self.freqs / 1e9
-        a1     = 1.734e-3  # sqrt(ns)/mm
-        a2     = 1.455e-4  # ns/mm
-        tau    = 6.141e-3  # ns/mm
-        rho    = (zc - 2 * r0) / (zc + 2 * r0)
+        f_GHz  = self.freqs / 1e9               # noqa E221
+        a1     = 1.734e-3  # sqrt(ns)/mm        # noqa E221
+        a2     = 1.455e-4  # ns/mm              # noqa E221
+        tau    = 6.141e-3  # ns/mm              # noqa E221
+        rho    = (zc - 2 * r0) / (zc + 2 * r0)  # noqa E221
         gamma0 = 0         # 1/mm
         gamma1 = a1 * (1 + 1j)
 
@@ -672,7 +694,7 @@ class COM(HasTraits):
                 self.params['dfe_max'],
                 (vic_pulse_resp_post_samps[:nDFE] / vic_curs_val)))
         hISI = vic_pulse_resp_isi_samps \
-             - vic_curs_val * np.pad(dfe_tap_weights,
+             - vic_curs_val * np.pad(dfe_tap_weights,  # noqa E127
                                      (n_pre, len(vic_pulse_resp_post_samps) - nDFE),
                                      mode='constant',
                                      constant_values=0)  # (93A-27)
@@ -849,8 +871,8 @@ class COM(HasTraits):
             """
             (93A-39)
             """
-            return 1 / L * sum([np.roll(delta, int((2 * l / (L - 1) - 1) * hn / ystep))
-                                for l in range(L)])
+            return 1 / L * sum([np.roll(delta, int((2 * el / (L - 1) - 1) * hn / ystep))
+                                for el in range(L)])
 
         def p(h_samps: Rvec) -> Rvec:
             """
@@ -910,7 +932,7 @@ class COM(HasTraits):
                 self.params['dfe_max'],
                 (vic_pulse_resp_post_samps[:nDFE] / vic_curs_val)))
         hISI = vic_pulse_resp_isi_samps \
-             - vic_curs_val * np.pad(dfe_tap_weights,
+             - vic_curs_val * np.pad(dfe_tap_weights,  # noqa E127
                                      (n_pre, len(vic_pulse_resp_post_samps) - nDFE),
                                      mode='constant',
                                      constant_values=0)  # (93A-27)

PyChOpMarg-0.1.2/src/pychopmarg/view.py

@@ -0,0 +1,62 @@
+"""
+Default view definition for `PyChOpMarg.COM` class.
+
+Original author: David Banas <capn.freako@gmail.com>
+
+Original date:   March 26, 2024
+
+Copyright (c) 2024 David Banas; all rights reserved World wide.
+"""
+
+from enable.component_editor import ComponentEditor
+from numpy                   import log10, array
+from pyface.image_resource   import ImageResource
+from traitsui.api import (  # CloseAction,
+    Action,
+    CheckListEditor,
+    FileEditor,
+    Group,
+    HGroup,
+    Item,
+    Menu,
+    MenuBar,
+    NoButtons,
+    ObjectColumn,
+    RangeEditor,
+    Separator,
+    TableEditor,
+    TextEditor,
+    VGroup,
+    View,
+    spring,
+)
+from traitsui.ui_editors.array_view_editor import ArrayViewEditor
+
+# Main window layout definition.
+traits_view = View(
+    Group(  # Members correspond to top-level tabs.
+        VGroup(  # "Config." tab
+            HGroup(
+                Item(
+                    name="ui",
+                    label="UI",
+                    tooltip="Unit Interval (ps)",
+                    show_label=True,
+                    enabled_when="True",
+                    editor=TextEditor(auto_set=False, enter_set=True, evaluate=float),
+                ),
+                Item(label="ps")
+            ),
+            label="Config."
+        ),
+        layout="tabbed",
+        springy=True,
+        id="tabs",
+    ),
+    resizable=True,
+    handler=MyHandler(),
+    buttons=NoButtons,
+    # statusbar="status_str",
+    title="PyChOpMarg",
+    # icon=ImageResource("icon.png"),
+)

PyChOpMarg-0.1/src/PyChOpMarg.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-pychopmarg = pychopmarg.com:cli