Skip to content

Workbench Documentation Map

Workbench documentation includes several types of learning materials, focused on different learning scenarios.

Tutorials

Tutorials are lessons that provide a basic introduction to a certain topic. They focus on introducing the basics of using Workbench and the main features and subroutines it provides. If you're new to Workbench, you'll want to start your learning journey here!

Tutorials structure

Workbench tutorials are organized into several sections by topic:

  • Writing Basic Programs introduces Workbench representation of the main elements of a quantum program: the program itself, qubits, gates, and measurements.

    Start with: QPU Object.

  • Running Basic Programs showcases Workbench tools for running, testing, and debugging quantum programs.

    Start with: Configuring Program Execution.

  • High-level Routines discusses the way Workbench represents routines - high-level building blocks of quantum programs - and how you can use them and implement your own ones.

    Start with: High-Level Routines: Qubricks.

  • Built-in Data Types and Routines walks you through the arithmetic data types and the main built-in routines offered by Workbench.

    Start with: Quantum Arithmetic Data Types.

  • Resource Estimation introduces you to the task of resource estimation and the tools Workbench provides for it.

    Start with: Getting Basic Numeric Resource Estimates.

We recommend you to start with the first two sections, since you'll use this knowledge to write and run any Workbench program. After you've learned the basics, feel free to choose whichever section looks most useful for your goals!

Deep dives

Deep dives are in-depth explanations of topics that are important for understanding how Workbench works. You probably don't want to start with them, but once you've learned the basics of using Workbench, they'll help you understand what's going on under the hood.

Start with: Workbench Execution Model

How-to guides

How-to guides are process references. Each how-to guide answers a question "How do I do X in Workbench?" by offering a checklist of steps you need to take to achieve X. How-to guides do not explain or motivate individual steps, instead pointing the reader to relevant tutorials or deep dives. If you're looking to do something particular, a how-to guide will help you figure out which tutorials you need to read.

Start with: How to Write a Simple Program.

API reference

Workbench Python API reference offers the detailed API reference for the key classes and built-in routines provided by Workbench.

Start with: Workbench Python API Overview.

Other learning materials

  • End-to-end tutorials in Construct documentation ⧉ show you how to use Workbench as part of the complete workflow of developing a quantum program, from a high-level circuit to code complete with tests and resource estimates.
  • Workbench Algorithms ⧉ offer an extensive set of quantum algorithms and subroutines that you can use in your Workbench programs.