Skip to content

update docstrings for device elements

Explanation of changes

Added some examples to docstring of BasicTransmonElement, BasicSpinElement and BasicNVsomething:

    .. admonition:: Examples

       Qubit parameters can be set either through submodule attributes

       .. jupyter-execute::

            from quantify_scheduler import BasicTransmonElement

            qubit = BasicTransmonElement("q0")

            qubit.rxy.amp180(0.1)
            qubit.measure.pulse_amp(0.25)
            qubit.measure.pulse_duration(300e-9)
            qubit.measure.acq_delay(430e-9)
            qubit.measure.integration_time(1e-6)
            ...

        or by passing a dictionary to the constructor

        .. jupyter-execute::

            qubit = BasicTransmonElement(
                "q0",
                rxy={"amp180": 0.1},
                measure={
                    "pulse_amp": 0.25,
                    "pulse_duration": 300e-9,
                    "acq_delay": 430e-9,
                    "integration_time": 1e-6,
                }
            )

Motivation of changes

Motivate why the particular solution was chosen.


Merge checklist

See also merge request guidelines

  • Merge request has been reviewed (in-depth by a knowledgeable contributor), and is approved by a project maintainer.
  • New code is covered by unit tests (or N/A).
  • New code is documented and docstrings use numpydoc format (or N/A).
  • New functionality: considered making private instead of extending public API (or N/A).
  • Public API changed: added @deprecated and entry in deprecated code suggestions (or N/A).
  • Newly added/adjusted documentation and docstrings render properly (or N/A).
  • Pipeline fix or dependency update: post in #software-for-developers channel to merge main back in or update local packages (or N/A).
  • Tested on hardware (or N/A).
  • CHANGELOG.md for breaking changes and AUTHORS.md have been updated (or N/A).
  • Update Hardware backends documentation if backend interface change or N/A
  • Check whether performance is significantly affected by looking at the Performance metrics results.
  • Windows tests in CI pipeline pass (manually triggered by maintainers before merging).
    • Maintainers do not hit Auto-merge, we need to actively check as manual tests do not block pipeline

For reference, the issues workflow is described in the contribution guidelines.

Merge request reports

Loading