PyChOpMarg 0.1__tar.gz → 0.1.3__tar.gz

{PyChOpMarg-0.1 → pychopmarg-0.1.3}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: PyChOpMarg
-Version: 0.1
+Version: 0.1.3
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3
+Project-URL: documentation, https://pychopmarg.readthedocs.io/en/latest/
 Keywords: com,channel,margin
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Environment :: Console
@@ -28,6 +29,9 @@ Classifier: Topic :: Utilities
 Requires-Python: <3.12,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: chaco>=6.0.0
+Requires-Dist: click
+Requires-Dist: pyside6
 Requires-Dist: scikit-rf>=0.29
 Requires-Dist: traitsui>=8
 

{PyChOpMarg-0.1 → pychopmarg-0.1.3}/pyproject.toml

@@ -1,17 +1,24 @@
 [build-system]
-requires = ["setuptools>=45"]
+requires = [
+    "Cython<3",
+    "setuptools>=45",
+    "swig<4",
+]
 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.3"
 authors = [{name = "David Banas", email = "capn.freako@gmail.com"}]
-# urls = { documentation = "https://github.com/capn-freako/PyBERT/wiki"}
+urls = { documentation = "https://pychopmarg.readthedocs.io/en/latest/"}
 readme = "README.md"
 requires-python = ">=3.9,<3.12"
 license = {text = "BSD3"}
 dependencies = [
+    "chaco>=6.0.0",
+    "click",
+    "pyside6",
     "scikit-rf>=0.29",
     "traitsui>=8",
 ]
@@ -40,7 +47,7 @@ classifiers=[
 ]
 
 [project.scripts]
-pychopmarg = "pychopmarg.com:cli"
+pychopmarg = "pychopmarg.cli:cli"
 
 [tool.setuptools.packages.find]
 where = ["src"]

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

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: PyChOpMarg
-Version: 0.1
+Version: 0.1.3
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3
+Project-URL: documentation, https://pychopmarg.readthedocs.io/en/latest/
 Keywords: com,channel,margin
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Environment :: Console
@@ -28,6 +29,9 @@ Classifier: Topic :: Utilities
 Requires-Python: <3.12,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: chaco>=6.0.0
+Requires-Dist: click
+Requires-Dist: pyside6
 Requires-Dist: scikit-rf>=0.29
 Requires-Dist: traitsui>=8
 

{PyChOpMarg-0.1 → pychopmarg-0.1.3}/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.3/src/PyChOpMarg.egg-info/entry_points.txt

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

{PyChOpMarg-0.1 → pychopmarg-0.1.3}/src/PyChOpMarg.egg-info/requires.txt

@@ -1,2 +1,5 @@
+chaco>=6.0.0
+click
+pyside6
 scikit-rf>=0.29
 traitsui>=8

pychopmarg-0.1.3/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 Exception:
+    __version__ = "(dev)"
+
+__date__ = "March 25, 2024"
+__authors__ = "David Banas"
+__copy__ = "Copyright (c) 2024 David Banas"

pychopmarg-0.1.3/src/pychopmarg/cli.py

@@ -0,0 +1,51 @@
+"""
+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.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)