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 convenience functionality more discoverable #804

Closed
4 tasks
shumpohl opened this issue Oct 11, 2023 · 0 comments · Fixed by #886
Closed
4 tasks

Make convenience functionality more discoverable #804

shumpohl opened this issue Oct 11, 2023 · 0 comments · Fixed by #886

Comments

@shumpohl
Copy link
Member

shumpohl commented Oct 11, 2023

The pulse building related current convenience functionality includes

  • with_* methods like with_mapping
  • pad_to method
  • duration
  • final_values and initial_values
  • integral
  • Arithmetics
  • Time reversal

Currently these are either in their own example like https://github.com/qutech/qupulse/blob/master/doc/source/examples/00ArithmeticWithPulseTemplates.ipynb or are used in some examples when the author at the time thought of them.

  • Add a paragraph or section in the documentation that
    • explains usecases for all of these methods by referring to
    • an FAQ like section where the usecases are demonstrated
  • Add an example that showcases all convenience functionality.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant