-
Notifications
You must be signed in to change notification settings - Fork 368
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Pulse simulator doc strings and changing naming of qubit_list
#562
Merged
chriseclectic
merged 15 commits into
Qiskit:master
from
DanPuzzuoli:pulse-sim-doc-strings
Jan 30, 2020
Merged
Pulse simulator doc strings and changing naming of qubit_list
#562
chriseclectic
merged 15 commits into
Qiskit:master
from
DanPuzzuoli:pulse-sim-doc-strings
Jan 30, 2020
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
…__init__ for sphinx
…iring in situations when it isn't actually an issue and may just be a result of non-uniqueness of eigen decompositions
DanPuzzuoli
force-pushed
the
pulse-sim-doc-strings
branch
from
January 30, 2020 19:50
2ac0f02
to
76e0bb1
Compare
… in all relevant places. Also removed oscillator_dims from HamiltonianModel
DanPuzzuoli
changed the title
Pulse simulator doc strings
Pulse simulator doc strings and changing naming of Jan 30, 2020
qubit_list
chriseclectic
approved these changes
Jan 30, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
I want to restructure some of the API docs a little bit (add the pulse models to their own section, not have them show up under the provider), but I will make a follow up PR to do this, along with a general cleanup of inits and paths in the pulse directory.
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.
Summary
Closes #433
Closes #500
Adding doc strings for for pulse simulator files
pulse_simulator.py
,pulse_system_model.py
,duffing_model_generators.py
.Changed
qubit_list
tosubsystem_list
inhamiltonian_model
,pulse_system_model
, anddigest
, and updated all relevant tests.Details and comments
Changes are:
__init__.py
file to put relevant classes/methods in API doc generations: addedPulseSimulator
to the list of backends, and added a section calledOpenPulse
to havePulseSystemModel
andduffing_model_generators
.__init__.py
file to importPulseSimulator
.__init__.py
file to importduffing_system_model
andPulseSystemModel
.HamiltonianModel
as it was going off in situations that it shouldn't, and updated related test to not check for the warning.qubit_list
tosubsystem_list
andqubit_dims
tosubsystem_dims
in all relevant places, and removedoscillator_dims
fromHamiltonianModel
.