Skip to content

Draft: Documentation compilation config

Tobias Bonsenrequested to merge
documentation_compilation_config into main

Explanation of changes

  • Updates the "Compilation" section in the User guide to explain hardware options and connectivity datastructures (Fig 2 also needs to be updated) - Note: we might want to hide this change from the user until these datastructures are fully implemented
  • Updates the "Tutorial: Compiling to Hardware" to describe the full compilation from the quantum-circuit layer to compiled instructions:
    • start from a (hybrid) Schedule containing gates and pulses
    • show the structure of the SerialCompiler (graph) and CompilationConfig
    • perform the compilation and show compiled instructions
    • "Execution on the hardware" stays the same
  • Hardware options are removed from the backend-specific parts of the documentation. These are then added to the "Compilation" section of the user guide.
  • Notes are added to warn that the "Hardware configuration" will be deprecated once the HardwareOptions and Connectivity datastructures have been implemented

Motivation of changes

We are working on a new structure of the CompilationConfig (see &1 (closed)). The documentation needs to properly explain this structure and how to use it.

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 (or N/A).
  • Tested on hardware (or N/A).
  • CHANGELOG.md and AUTHORS.md have been updated (or N/A).
  • Windows tests in CI pipeline pass (manually triggered by maintainers before merging).

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

Merge request reports