Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

qsharp (compatibility shim)

Deprecated. The qsharp package is a thin compatibility shim that re-exports the qdk public API. New projects should use qdk directly.

Installation

pip install qsharp

This installs the qdk package as a dependency. For new projects, consider installing qdk directly instead:

pip install qdk

Migration

Replace:

import qsharp
qsharp.init()
qsharp.eval("...")

With:

import qdk
qdk.init()

Optional extras previously installed via qsharp[…] are now available as qdk[…]:

Old extra New extra
qsharp[jupyterlab] qdk[jupyter]
qsharp[widgets] qdk[jupyter]
qsharp[qiskit] qdk[qiskit]
qsharp[cirq] qdk[cirq]

What this package provides

When imported, the qsharp shim:

  1. Emits a DeprecationWarning directing users to migrate to qdk.
  2. Re-exports the core Q# interpreter API (init, eval, run, compile, circuit, estimate, dump_machine, dump_circuit, dump_operation, set_quantum_seed, set_classical_seed, etc.) from qdk.qsharp.
  3. Re-exports key types: Result, Pauli, QSharpError, TargetProfile, StateDump, ShotResult, PauliNoise, DepolarizingNoise, BitFlipNoise, PhaseFlipNoise, CircuitGenerationMethod.

Submodules such as qsharp.estimator, qsharp.openqasm, and qsharp.code similarly re-export from their qdk counterparts.

Telemetry

This library sends telemetry via the qdk package. To disable it, set the environment variable QDK_PYTHON_TELEMETRY=none.

Support

For more information about the Microsoft Quantum Development Kit, visit https://aka.ms/qdk.

Contributing

Visit the Quantum Development Kit GitHub repository at https://github.com/microsoft/qdk to find out more about the project.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qsharp-1.29.5.dev0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file qsharp-1.29.5.dev0-py3-none-any.whl.

File metadata

  • Download URL: qsharp-1.29.5.dev0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: RestSharp/106.13.0.0

File hashes

Hashes for qsharp-1.29.5.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 089c4ce686dbd52c7ba76feac0f6b1fdc718622dade915bce401c2ea2ab9ea19
MD5 316f4b09807f9fe14f31117bcee89cd4
BLAKE2b-256 76912ea0ffb85f560b23539547ab9bda33dd3a66b255912dcc353eba3114391b

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page