Skip to content

PsiQ/psiqdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PsiQuantum Development Kit (PsiQDK)

Welcome to the PsiQuantum Development Kit - an integrated set of Python packages for designing, simulating, and analyzing quantum programs targeted at fault-tolerant quantum computers.

PsiQDK bundles the core components you need to write a quantum program, simulate it, estimate the cost of running it on fault-tolerant hardware, and visualize the results.

What's in PsiQDK?

Component Purpose
Workbench A Python framework with an optimized C++ backend for writing and simulating quantum programs and perform resource estimation.
Algorithms A growing library of reusable quantum algorithm primitives - state preparation, arithmetic, phase estimation, data loading, Hamiltonian simulation, and more.
Visualize Jupyter widgets and editor integrations for inspecting circuits and resource-estimation reports.

Installation

Prerequisites

  • Python: 3.11, 3.12, or 3.13
  • Operating system: Linux or macOS (Windows via WSL)
  • Optional: GraphViz for rendering call graphs in resource-estimation reports

Installing PsiQDK

PsiQDK is distributed as a single meta-package that pins compatible versions of each component:

pip install psiqdk

Once installed, verify the installation:

psiqdk --version

Documentation and examples

  • Documentation – Comprehensive PsiQDK documentation is available on the Construct website.
  • Tutorials in this repository - Jupyter notebooks that mirror the documentation and can be run end-to-end:
    • Workbench tutorials - gates, qubit management, simulation, resource estimation, and the Qubricks framework.
    • Algorithms tutorials - state preparation, amplitude amplification, phase estimation, arithmetic, QROM, and more.
    • Visualization examples - interactive circuit and QRE viewers for Jupyter and VS Code.
    • End-to-end examples - full algorithm-design → implementation → resource-estimation workflows (Grover SAT solver, recursive state preparation).

Other learning resources

  • Workbench Quantum Katas - a hands-on collection of tutorials and programming exercises that teach quantum computing and quantum programming, from basic concepts to fault-tolerant applications such as quantum chemistry.
  • Quantum Programming in Depth - side-by-side code samples in three quantum development toolkits: Workbench, Q#, and Qiskit from the book Quantum Programming in Depth written by Mariia Mykhailova.

Support policy

PsiQuantum officially supports the current stable release of PsiQDK. Older releases are best-effort only.

Feedback and contributing

PsiQDK is an open-access, but we are working to turn it into an open-source project. Because of this, there is not direct way for us to accept external contributions to the repository.

To share any feedback (including bug reports, feature requests, and discussions), please file an issue to report a bug or to request a feature, or start a discussion to ask a question or discuss a topic.

License

See LICENSE.

© PsiQuantum Corp.

About

Meta-package for PsiQuantum's Quantum Development Kit; install once to pull in workbench, algorithms, and visualization at compatible versions

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors