Rename get_noisy_dynamics to get_noisy_pulses #76
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the noise module, users are allowed to define custom noise for their own physical model. The `Noise` class uses a hook method `get_noisy_dynamics` to realize this. This method will be called when including noise in the physical model. However, the name `get_noisy_dynamics` was wrong because the noise object returns a list of `Pulse`, instead of `QobjEvo`. This PR fixed this issue and use the term `get_noisy_pulses`. The old API is still usable but will issue a `PendingDeprecationWarning`.
hodgestar
reviewed
Jul 12, 2021
hodgestar
reviewed
Jul 12, 2021
hodgestar
approved these changes
Jul 12, 2021
hodgestar
reviewed
Jul 12, 2021
|
The duplication of the docstrings is not great, but definitely better to have the documentation appear in the apidocs than not. |
Co-authored-by: Simon Cross <hodgestar+github@gmail.com>
hodgestar
reviewed
Jul 14, 2021
hodgestar
reviewed
Jul 14, 2021
Co-authored-by: Simon Cross <hodgestar+github@gmail.com>
|
Thanks for correcting the typos! |
Co-authored-by: Simon Cross <hodgestar+github@gmail.com>
BoxiLi
added a commit
to BoxiLi/qutip-qip
that referenced
this pull request
Jul 18, 2021
* rename get_noisy_dynamics to get_noisy_pulses In the noise module, users are allowed to define custom noise for their own physical model. The `Noise` class uses a hook method `get_noisy_dynamics` to realize this. This method will be called when including noise in the physical model. However, the name `get_noisy_dynamics` was wrong because the noise object returns a list of `Pulse`, instead of `QobjEvo`. This PR fixed this issue and use the term `get_noisy_pulses`. The old API is still usable but will issue a `PendingDeprecationWarning`. Co-authored-by: Simon Cross <hodgestar+github@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In the noise module, users are allowed to define custom noise for their own physical model. The
Noiseclass uses a hook methodget_noisy_dynamicsto realize this. This method will be called when including noise in the physical model.It was pointed out by @quantshah that the name
get_noisy_dynamicswas wrong because the noise object returns a list ofPulse, instead ofQobjEvo. This PR fixed this issue and use the termget_noisy_pulses. The old API is still usable but will issue aPendingDeprecationWarning.I also copied the docstring of
get_noisy_pulsesto those in the subclass for easier reference. I originally thought that if the docstrings are missing, they will be inherited automatically, but this is not the case.I also pinned @hodgestar because I briefly mentioned this and asked for your advice in one of our discussions.