Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. This could point to a cell in the updated notebooks. Or a snippet of code with accompanying figures here.
Checklist (while developing)
[ ] I have added docstrings to all new functions.
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] Tests added for pytest, if necessary.
[ ] I have updated the sphinx documentation, if necessary.
Pre-Merge Checklist (final steps)
[ ] I have rebased onto master or develop (wherever I am merging) and dealt with any conflicts.
[ ] I have squashed commits to a reasonable amount, and force-pushed the squashed commits.
[ ] I have run make html on the documents to make sure example notebooks still compile.
References
Please add any references to manuscripts, textbooks, etc.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. This could point to a cell in the updated notebooks. Or a snippet of code with accompanying figures here.
Checklist (while developing)
pytest
, if necessary.Pre-Merge Checklist (final steps)
make html
on the documents to make sure example notebooks still compile.References
Please add any references to manuscripts, textbooks, etc.