Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
Issue ticket number and link
Fixes # (issue)
Type of change
Please delete options that are not relevant.
[x] Bug fix (non-breaking change which fixes an issue)
[x] 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
Checklist before requesting a review
[x] I have performed a self-review of my code
[x] Code changes are covered by tests.
[x] Code changes have been evaluated for compatibility/integration with Scenario analysis (for future PRs)
[x] New functions added to init.py
[x] API.rst is up to date, along with other sphinx docs pages
[x] Example notebooks are rerun and differences in results scrutinized
[x] What's new changelog has been updated in the docs
Describe your changes
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
Issue ticket number and link
Fixes # (issue)
Type of change
Please delete options that are not relevant.
Checklist before requesting a review