This release is a pre-release and may not be stable for production use.
qdk
The Quantum Development Kit (QDK) provides a single, cohesive Python entry point for compiling, simulating, and estimating resources for quantum programs (Q# and OpenQASM), with optional extras for visualization, cloud workflows, and interoperability with Qiskit and Cirq.
Install
To install the core functionality, which include Q# & OpenQASM simulation, compilation, and resource estimation support:
pip install qdk
To include the Jupyter extra, which adds visualizations using Jupyter Widgets in the qdk.widgets submodule and syntax highlighting for Jupyter notebooks in the browser:
pip install "qdk[jupyter]"
To add the Azure Quantum extra, which includes functionality for working with the Azure Quantum service in the qdk.azure submodule:
pip install "qdk[azure]"
For Qiskit integration, which exposes Qiskit interop utilities in the qdk.qiskit submodule:
pip install "qdk[qiskit]"
For Cirq integration, which exposes Cirq interop utilities in the qdk.cirq submodule:
pip install "qdk[cirq]"
To easily install all the above extras:
pip install "qdk[all]"
Quick Start
from qdk import qsharp
result = qsharp.run("{ use q = Qubit(); H(q); return MResetZ(q); }", shots=100)
print(result)
To use widgets (installed via qdk[jupyter] extra):
from qdk.qsharp import eval, run
from qdk.widgets import Histogram
eval("""
operation BellPair() : Result[] {
use qs = Qubit[2];
H(qs[0]);CX(qs[0], qs[1]);
MResetEachZ(qs)
}
""")
results = run("BellPair()", shots=1000, noise=(0.005, 0.0, 0.0))
Histogram(results)
Public API Surface
Submodules:
qdk.qsharp– Q# interpreter functions:init,eval,run,compile,circuit,estimate,dump_machine,dump_circuit,dump_operation, and related types.qdk.openqasm– OpenQASM compilation and execution.qdk.estimator– resource estimation utilities.qdk.simulation– noise-aware simulation utilities:NeutralAtomDevice,NoiseConfig,run_qir,DensityMatrixSimulator,StateVectorSimulator, and related types.qdk.code– dynamic namespace populated at runtime with user-defined Q# and OpenQASM callables.qdk.qre– quantum resource estimation v3:estimate,Application,Architecture,ISA,ISATransform, and related types.qdk.applications– domain-specific quantum applications (e.g.qdk.applications.magnets).qdk.widgets– Jupyter widgets for visualization (requires theqdk[jupyter]extra).qdk.azure– Azure Quantum service integration (requires theqdk[azure]extra).qdk.qiskit– Qiskit interop:QSharpBackend,NeutralAtomBackend, and related types (requires theqdk[qiskit]extra).qdk.cirq– Cirq interop:NeutralAtomSampler(requires theqdk[cirq]extra).
Top level exports
For convenience, the following helpers and types are also importable directly from the qdk root (e.g. from qdk import code, Result). Algorithm execution APIs (like run / estimate) remain under qdk.qsharp or qdk.openqasm.
| Symbol | Type | Origin | Description |
|---|---|---|---|
code |
module | qdk.code |
Exposes operations defined in Q# or OpenQASM |
init |
function | qdk.qsharp.init |
Initialize/configure the QDK interpreter (target profile, options). |
set_quantum_seed |
function | qdk.qsharp.set_quantum_seed |
Deterministic seed for quantum randomness (simulators). |
set_classical_seed |
function | qdk.qsharp.set_classical_seed |
Deterministic seed for classical host RNG. |
dump_machine |
function | qdk.qsharp.dump_machine |
Emit a structured dump of full quantum state (simulator dependent). |
Result |
class | qdk.qsharp.Result |
Measurement result token. |
TargetProfile |
class | qdk.qsharp.TargetProfile |
Target capability / profile descriptor. |
StateDump |
class | qdk.qsharp.StateDump |
Structured state dump object. |
ShotResult |
class | qdk.qsharp.ShotResult |
Multi-shot execution results container. |
PauliNoise |
class | qdk.qsharp.PauliNoise |
Pauli channel noise model spec. |
DepolarizingNoise |
class | qdk.qsharp.DepolarizingNoise |
Depolarizing noise model spec. |
BitFlipNoise |
class | qdk.qsharp.BitFlipNoise |
Bit-flip noise model spec. |
PhaseFlipNoise |
class | qdk.qsharp.PhaseFlipNoise |
Phase-flip noise model spec. |
Context |
class | qdk.Context |
Isolated Q# and OpenQASM interpreter context for independent sessions. |
Configuration Map
You can provide configuration at initialization time as a Python dictionary.
In Python, pass qdk_config: dict[str, int | float | str | bool] to Context(...).
If qdk_config is omitted, the configuration map is empty. The map is immutable
after initialization. To use different configuration values, create a new Context.
In Q#, read values with Std.Core.ConfigValue(name, defaultValue). In Q# code, config
values are immutable: in the same program, repeated calls with the same
(name, defaultValue) produce the same result.
Supported types: int, float, str, and bool (corresponding to Int, Double,
String and Bool in Q#). The type of each value in qdk_config must match the
type of its corresponding default value.
Example:
import qdk
context = qdk.Context(qdk_config={"experiment_name": "baseline", "shots": 1000})
assert context.eval('Std.Core.ConfigValue("experiment_name", "")') == "baseline"
assert context.eval('Std.Core.ConfigValue("shots", 100)') == 1000
assert context.eval('Std.Core.ConfigValue("noise_level", 0.01)') == 0.01
Telemetry
This library sends telemetry. Minimal anonymous data is collected to help measure feature usage and performance. All telemetry events can be seen in the source file telemetry_events.py.
To disable sending telemetry from this package, set the environment variable QDK_PYTHON_TELEMETRY=none
Support
For more information about the Microsoft Quantum Development Kit, visit https://aka.ms/qdk.
Contributing
Q# welcomes your contributions! Visit the Q# GitHub repository at [https://github.com/microsoft/qdk] to find out more about the project.
1 maintainer
Release files for qdk 1.31.3.dev0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| qdk-1.31.3.dev0-cp310-abi3-win_arm64.whl | CPython 3.10 | abi3 | Windows ARM64 | Details |
| qdk-1.31.3.dev0-cp310-abi3-win_amd64.whl | CPython 3.10 | abi3 | Windows x86-64 | Details |
| qdk-1.31.3.dev0-cp310-abi3-manylinux_2_35_x86_64.whl | CPython 3.10 | abi3 | Linux glibc 2.35+ x86-64 | Details |
| qdk-1.31.3.dev0-cp310-abi3-manylinux_2_35_aarch64.whl | CPython 3.10 | abi3 | Linux glibc 2.35+ ARM64 | Details |
| qdk-1.31.3.dev0-cp310-abi3-macosx_11_0_arm64.whl | CPython 3.10 | abi3 | macOS 11.0+ ARM64 | Details |
| qdk-1.31.3.dev0-cp310-abi3-macosx_10_12_x86_64.whl | CPython 3.10 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 43.3 MB
Release files / qdk-1.31.3.dev0-cp310-abi3-win_arm64.whl
| Download URL | qdk-1.31.3.dev0-cp310-abi3-win_arm64.whl |
|---|---|
| Size | 7.6 MB |
| Tags | CPython 3.10 Windows ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
26e975cb14dbdf27242d0d1f985a5b3b17539a357f4e5df6b39e54fc39f10dd7
|
|
BLAKE2b-256 checksum How to use checksums |
a5c9948ad29bc8a3db023a5733162612c19825e09fc17a4e34aa88a5ca406eda
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|
Release files / qdk-1.31.3.dev0-cp310-abi3-win_amd64.whl
| Download URL | qdk-1.31.3.dev0-cp310-abi3-win_amd64.whl |
|---|---|
| Size | 8.1 MB |
| Tags | CPython 3.10 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
673a5794fbe30b609d7aa873e8282bda75bf0452f1886db91e690c2d5980473f
|
|
BLAKE2b-256 checksum How to use checksums |
5c483392ec778b122b540f433099c114f621b63eb325862fca516bd27ab0d99d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|
Release files / qdk-1.31.3.dev0-cp310-abi3-manylinux_2_35_x86_64.whl
| Download URL | qdk-1.31.3.dev0-cp310-abi3-manylinux_2_35_x86_64.whl |
|---|---|
| Size | 7.6 MB |
| Tags | CPython 3.10 Linux glibc 2.35+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
ac99526a71d2e6773854eb81aaa33fd87876ed3ed12d5b388e234c348b19820c
|
|
BLAKE2b-256 checksum How to use checksums |
018a5b371f7f822958294ad14f4ae710752ba0ed0114b57b3f6b54948689b530
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|
Release files / qdk-1.31.3.dev0-cp310-abi3-manylinux_2_35_aarch64.whl
| Download URL | qdk-1.31.3.dev0-cp310-abi3-manylinux_2_35_aarch64.whl |
|---|---|
| Size | 7.0 MB |
| Tags | CPython 3.10 Linux glibc 2.35+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
460ef4f95a7697d2803c221a15617eacfc62e23944527e7689a5cda58d7df747
|
|
BLAKE2b-256 checksum How to use checksums |
a9ab64b33991482180ea436eaedfa5e95cfc7324e1e9d289112e23fefc81ae53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|
Release files / qdk-1.31.3.dev0-cp310-abi3-macosx_11_0_arm64.whl
| Download URL | qdk-1.31.3.dev0-cp310-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 6.3 MB |
| Tags | CPython 3.10 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
fb7278afd72a34d6bd12ea2e4612d1085d409404d4f61b75e65b25e1fe2c55fa
|
|
BLAKE2b-256 checksum How to use checksums |
368e3d982d8969334eff7fb1dd6ec3d07c39ff20f4a9f82e270e8da3792985cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|
Release files / qdk-1.31.3.dev0-cp310-abi3-macosx_10_12_x86_64.whl
| Download URL | qdk-1.31.3.dev0-cp310-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 6.7 MB |
| Tags | CPython 3.10 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
5e7f80101d0c4b69fe5e36f597aea9cf936ff9b34a85af0db707a64b8c6615f1
|
|
BLAKE2b-256 checksum How to use checksums |
087ea0525a5468dcd1be928add84e36d8b04a0b5e025a978d7a5bd6dd960fd96
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|
