Skip to content
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
merged 15 commits into from
Jan 30, 2020

Conversation

DanPuzzuoli
Copy link
Contributor

@DanPuzzuoli DanPuzzuoli commented Jan 30, 2020

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 to subsystem_list in hamiltonian_model, pulse_system_model, and digest, and updated all relevant tests.

Details and comments

Changes are:

  1. Added doc strings for relevant classes/functions in above mentioned files.
  2. Updated aer __init__.py file to put relevant classes/methods in API doc generations: added PulseSimulator to the list of backends, and added a section called OpenPulse to have PulseSystemModel and duffing_model_generators.
  3. Updated backends __init__.py file to import PulseSimulator.
  4. Updated openpulse __init__.py file to import duffing_system_model and PulseSystemModel.
  5. Removed warning for off-diagonal pieces of Hamiltonian from eigenvector re-ordering code in HamiltonianModel as it was going off in situations that it shouldn't, and updated related test to not check for the warning.
  6. Changed qubit_list to subsystem_list and qubit_dims to subsystem_dims in all relevant places, and removed oscillator_dims from HamiltonianModel.

@DanPuzzuoli DanPuzzuoli force-pushed the pulse-sim-doc-strings branch from 2ac0f02 to 76e0bb1 Compare January 30, 2020 19:50
@DanPuzzuoli DanPuzzuoli changed the title Pulse simulator doc strings Pulse simulator doc strings and changing naming of qubit_list Jan 30, 2020
Copy link
Member

@chriseclectic chriseclectic left a 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.

@chriseclectic chriseclectic merged commit 804b670 into Qiskit:master Jan 30, 2020
@DanPuzzuoli DanPuzzuoli deleted the pulse-sim-doc-strings branch June 4, 2020 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants