PyChOpMarg 2.0.1__tar.gz → 2.1.1__tar.gz

{pychopmarg-2.0.1 → pychopmarg-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyChOpMarg
-Version: 2.0.1
+Version: 2.1.1
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3
@@ -36,4 +36,7 @@ Requires-Dist: scikit-rf>=0.29
 Requires-Dist: typing_extensions
 
 # PyChOpMarg
-Python implementation of COM, as per IEEE 802.3-22 Annex 93A.
+
+Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A.
+
+- [Documentation](https://pychopmarg.readthedocs.io/en/latest/index.html)

pychopmarg-2.1.1/README.md

@@ -0,0 +1,5 @@
+# PyChOpMarg
+
+Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A.
+
+- [Documentation](https://pychopmarg.readthedocs.io/en/latest/index.html)

{pychopmarg-2.0.1 → pychopmarg-2.1.1}/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 = "2.0.1"
+version = "2.1.1"
 authors = [{name = "David Banas", email = "capn.freako@gmail.com"}]
 urls = { documentation = "https://pychopmarg.readthedocs.io/en/latest/"}
 readme = "README.md"

{pychopmarg-2.0.1 → pychopmarg-2.1.1}/src/PyChOpMarg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyChOpMarg
-Version: 2.0.1
+Version: 2.1.1
 Summary: Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A.
 Author-email: David Banas <capn.freako@gmail.com>
 License: BSD3
@@ -36,4 +36,7 @@ Requires-Dist: scikit-rf>=0.29
 Requires-Dist: typing_extensions
 
 # PyChOpMarg
-Python implementation of COM, as per IEEE 802.3-22 Annex 93A.
+
+Python implementation of COM, as per IEEE 802.3-22 Annex 93A/178A.
+
+- [Documentation](https://pychopmarg.readthedocs.io/en/latest/index.html)

{pychopmarg-2.0.1 → pychopmarg-2.1.1}/src/PyChOpMarg.egg-info/SOURCES.txt

@@ -14,4 +14,8 @@ src/pychopmarg/com.py
 src/pychopmarg/common.py
 src/pychopmarg/noise.py
 src/pychopmarg/optimize.py
-src/pychopmarg/utility.py
+src/pychopmarg/utility/__init__.py
+src/pychopmarg/utility/filter.py
+src/pychopmarg/utility/general.py
+src/pychopmarg/utility/probability.py
+src/pychopmarg/utility/sparams.py

{pychopmarg-2.0.1 → pychopmarg-2.1.1}/src/pychopmarg/__init__.py

@@ -15,7 +15,7 @@ from importlib.metadata import version as _get_version
 # Set PEP396 version attribute
 try:
     __version__ = _get_version("PyChOpMarg")
-except Exception:
+except Exception:  # pylint: disable=broad-exception-caught
     __version__ = "(dev)"
 
 __date__ = "October 21, 2024"

{pychopmarg-2.0.1 → pychopmarg-2.1.1}/src/pychopmarg/__main__.py

@@ -7,5 +7,7 @@ Original Date:   27 August 2024
 Copyright (c) 2024 David Banas; all rights reserved World wide.
 """
 
-from pychopmarg.cli import cli
-cli()
+# from pychopmarg.cli import cli
+# cli()
+print("Sorry, the PyChOpMarg package is currently only usable as a library.")
+print("It's GUI is currently broken.")

pychopmarg-2.1.1/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.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)