IEEE P802.3dj D1.3 Compatibility and Agreement

What's Changed

• IEEE P802.3dj Compatibility and Agreement by @capn-freako in #23

Full Changelog: v2.2.1...v3.1.0

Installation & Upgrade

• pip install --upgrade PyChOpMarg

Documentation

• PyChOpMarg on ReadTheDocs

Release Notes

1. The focus of this release was twofold:

   a. Allow the configuration of a PyChOpMarg run to be defined by the same MS Excel spreadsheet used to configure a MATLAB COM run.
   b. Establish agreement in the final COM calculation between the two tools for a narrow test channel set.

2. The Jupyter notebook is currently the best reference for both:

   a. the current state of agreement between the two tools, and
   b. how to use the PyChOpMarg package in your own work.

Consolidated COM parameters into Python dataclass.

The numerous COM class attributes have been consolidated into a new COMParams dataclass.

Note: Potential for breaking existing client code, due to hierarchical naming changes of COM parameters.

What's Changed

• Rel. v2.2.1 by @capn-freako in #22

Full Changelog: v2.1.2...v2.2.1

v2.1.2

This release is primarily for developers.

What's Changed

• Comments cleaned up for better Sphinx-generated documentation. by @capn-freako in #18

• New makefile driven testing/build flow. (Run make to see a list of targets.)

Full Changelog: v2.1.1...v2.1.2

Install / Upgrade

pip install --upgrade PyChOpMarg

Documentation

v2.1.1

This is a "developer-only" release.
The focus of this release was:

• code clean-up, and
• build infrastructure completion.

No significant functional changes were made.

What's Changed

• 7 unify code flow for przf and mmse equalization optimization by @capn-freako in #11
• FOM and COM results storage cleaned up. by @capn-freako in #12
• Factored utility module. by @capn-freako in #13
• 5 add a makefile by @capn-freako in #16

Full Changelog: v2.0.1...v2.1.1

IEEE P802.3dj D1.2 Support

What's Changed

• 2 complete support for ieee 8023dj by @capn-freako in #4
  • To assess the new functionality for yourself, view this Jupyter notebook and scroll down to the MMSE vs. PRZF section.
  • You can ignore everything below and including the MATLAB vs PyChOpMarg section, as it's either incomplete or moot.

New Contributors

• @capn-freako made their first contribution in #4

Full Changelog: v1.1.3...v2.0.1

Caveats

• The GUI is now broken!
  • This was necessary, to support Python 3.13.
  • Jupyter notebook usage may be the only viable one for a while; sorry. :(

Installation & Upgrade

• pip install --upgrade PyChOpMarg

Documentation

• PyChOpMarg on ReadTheDocs

First Release

This initial release of the PyChOpMarg Python package supports 2 of the 3 intended operational modes:

• GUI "applet", and
• Library

Command line operation w/ existing MS Excel configuration spreadsheets will come later.