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

Make relationship between signals and hamiltonian_operators explicit in tutorial. #274

Open
hodgestar opened this issue Oct 22, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@hodgestar
Copy link

In https://qiskit.org/ecosystem/dynamics/tutorials/Rabi_oscillations.html the relationship between the hamiltonian_operators, the signals passed to the solver and the time-dependent term in the Hamiltonian isn't explicitly stated. I think readers who are not familiar with how such solvers structure things might not easily pick this up.

I also find the name hamiltonian_operators for the time-dependent / signal operators a bit strange. The static part of the Hamiltonian is also a Hamiltonian operator. Perhaps naming the argument signal_operators might this clearer?

@hodgestar hodgestar added the documentation Improvements or additions to documentation label Oct 22, 2023
@DanPuzzuoli
Copy link
Collaborator

I agree the naming is a little odd. It's been a while so I can't remember the alternatives we had considered, but I think we settled on the current naming conventions as a compromise between clarity and wanting to avoid the argument names being too long. (E.g. signal_operators isn't quite correct either as there are signals that can be supplied as coefficients for dissipator terms as well.)

At the stage I'm resistant to changing them as they've been with the package for so long. However, I think giving more explanation in the tutorial would be good. I've also just reread the Solver class documentation and that can be clarified as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants