Add type annotations to the microwave interface. Expand on the main module docstring and add a docstring for configure_scan.
Base MicrowaveConstraints on ScalarConstraint while keeping backwards compatibility.
Motivation and Context
I noticed that the interface is difficult to understand for people who are unfamiliar with it. I hope that the added documentation helps people in hardware implementations.
How Has This Been Tested?
With the dummy ODMR toolchain.
Types of changes
[X] Bug fix
[X] New feature
[ ] Breaking change (Causes existing functionality to not work as expected)
Checklist:
[x] My code follows the code style of this project.
[x] I have documented my changes in /docs/changelog.md.
[ ] My change requires additional/updated documentation.
[x] I have updated the documentation accordingly.
[ ] I have added/updated the config example for any module docstrings as necessary.
[x] I have checked that the change does not contain obvious errors
(syntax, indentation, mutable default values, etc.).
[ ] I have tested my changes using 'Load all modules' on the default dummy configuration.
[ ] All changed Jupyter notebooks have been stripped of their output cells.
Description
Add type annotations to the microwave interface. Expand on the main module docstring and add a docstring for
configure_scan.Base
MicrowaveConstraintsonScalarConstraintwhile keeping backwards compatibility.Motivation and Context
I noticed that the interface is difficult to understand for people who are unfamiliar with it. I hope that the added documentation helps people in hardware implementations.
How Has This Been Tested?
With the dummy ODMR toolchain.
Types of changes
Checklist:
/docs/changelog.md.