pytket-qsharp

Microsoft’s QDK is a language and associated toolkit for quantum programming.

pytket-qsharp is an extension to pytket that allows pytket circuits to be executed on simulators and resource estimators from the Microsoft QDK.

pytket-qsharp is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS and Windows. To install, run:

pip install pytket-qsharp

In order to use pytket-qsharp you will first need to install the dotnet SDK (6.0) and the iqsharp tool. On some Linux systems it is also necessary to modify your PATH:

1. See this page for instructions on installing the SDK on your operating system.

2. On Linux, ensure that the dotnet tools directory is on your path. Typically this will be ~/.dotnet/tools.

3. Run dotnet tool install -g Microsoft.Quantum.IQSharp.

4. Run dotnet iqsharp install --user.

• API documentation
  • QsharpSimulatorBackend
    • QsharpSimulatorBackend.__init__()
    • QsharpSimulatorBackend.available_devices()
    • QsharpSimulatorBackend.cancel()
    • QsharpSimulatorBackend.circuit_status()
    • QsharpSimulatorBackend.default_compilation_pass()
    • QsharpSimulatorBackend.empty_cache()
    • QsharpSimulatorBackend.get_compiled_circuit()
    • QsharpSimulatorBackend.get_compiled_circuits()
    • QsharpSimulatorBackend.get_result()
    • QsharpSimulatorBackend.get_results()
    • QsharpSimulatorBackend.pop_result()
    • QsharpSimulatorBackend.process_circuit()
    • QsharpSimulatorBackend.process_circuits()
    • QsharpSimulatorBackend.rebase_pass()
    • QsharpSimulatorBackend.run_circuit()
    • QsharpSimulatorBackend.run_circuits()
    • QsharpSimulatorBackend.valid_circuit()
    • QsharpSimulatorBackend.backend_info
    • QsharpSimulatorBackend.expectation_allows_nonhermitian
    • QsharpSimulatorBackend.persistent_handles
    • QsharpSimulatorBackend.required_predicates
    • QsharpSimulatorBackend.supports_contextual_optimisation
    • QsharpSimulatorBackend.supports_counts
    • QsharpSimulatorBackend.supports_density_matrix
    • QsharpSimulatorBackend.supports_expectation
    • QsharpSimulatorBackend.supports_shots
    • QsharpSimulatorBackend.supports_state
    • QsharpSimulatorBackend.supports_unitary
  • QsharpToffoliSimulatorBackend
    • QsharpToffoliSimulatorBackend.__init__()
    • QsharpToffoliSimulatorBackend.available_devices()
    • QsharpToffoliSimulatorBackend.cancel()
    • QsharpToffoliSimulatorBackend.circuit_status()
    • QsharpToffoliSimulatorBackend.default_compilation_pass()
    • QsharpToffoliSimulatorBackend.empty_cache()
    • QsharpToffoliSimulatorBackend.get_compiled_circuit()
    • QsharpToffoliSimulatorBackend.get_compiled_circuits()
    • QsharpToffoliSimulatorBackend.get_result()
    • QsharpToffoliSimulatorBackend.get_results()
    • QsharpToffoliSimulatorBackend.pop_result()
    • QsharpToffoliSimulatorBackend.process_circuit()
    • QsharpToffoliSimulatorBackend.process_circuits()
    • QsharpToffoliSimulatorBackend.rebase_pass()
    • QsharpToffoliSimulatorBackend.run_circuit()
    • QsharpToffoliSimulatorBackend.run_circuits()
    • QsharpToffoliSimulatorBackend.valid_circuit()
    • QsharpToffoliSimulatorBackend.backend_info
    • QsharpToffoliSimulatorBackend.expectation_allows_nonhermitian
    • QsharpToffoliSimulatorBackend.persistent_handles
    • QsharpToffoliSimulatorBackend.required_predicates
    • QsharpToffoliSimulatorBackend.supports_contextual_optimisation
    • QsharpToffoliSimulatorBackend.supports_counts
    • QsharpToffoliSimulatorBackend.supports_density_matrix
    • QsharpToffoliSimulatorBackend.supports_expectation
    • QsharpToffoliSimulatorBackend.supports_shots
    • QsharpToffoliSimulatorBackend.supports_state
    • QsharpToffoliSimulatorBackend.supports_unitary
  • AzureBackend
    • AzureBackend.__init__()
    • AzureBackend.available_devices()
    • AzureBackend.cancel()
    • AzureBackend.circuit_status()
    • AzureBackend.default_compilation_pass()
    • AzureBackend.empty_cache()
    • AzureBackend.get_compiled_circuit()
    • AzureBackend.get_compiled_circuits()
    • AzureBackend.get_result()
    • AzureBackend.get_results()
    • AzureBackend.pop_result()
    • AzureBackend.process_circuit()
    • AzureBackend.process_circuits()
    • AzureBackend.rebase_pass()
    • AzureBackend.run_circuit()
    • AzureBackend.run_circuits()
    • AzureBackend.valid_circuit()
    • AzureBackend.backend_info
    • AzureBackend.expectation_allows_nonhermitian
    • AzureBackend.persistent_handles
    • AzureBackend.required_predicates
    • AzureBackend.supports_contextual_optimisation
    • AzureBackend.supports_counts
    • AzureBackend.supports_density_matrix
    • AzureBackend.supports_expectation
    • AzureBackend.supports_shots
    • AzureBackend.supports_state
    • AzureBackend.supports_unitary
  • tk_to_qsharp()
  • QSharpConfig
    • QSharpConfig.from_extension_dict()
  • set_azure_config()
• Changelog
  • 0.40.0 (March 2024)
  • 0.39.0 (January 2024)
  • 0.38.0 (January 2024)
  • 0.37.0 (November 2023)
  • 0.36.1 (November 2023)
  • 0.36.0 (October 2023)
  • 0.35.0 (September 2023)
  • 0.34.0 (June 2023)
  • 0.33.0 (February 2023)
  • 0.32.0 (January 2023)
  • 0.31.0 (November 2022)
  • 0.30.0 (November 2022)
  • 0.29.0 (October 2022)
  • 0.28.0 (August 2022)
  • 0.27.0 (July 2022)
  • 0.26.0 (June 2022)
  • 0.25.0 (May 2022)
  • 0.24.0 (April 2022)
  • 0.23.0 (March 2022)
  • 0.22.0 (unreleased)
  • 0.21.0 (February 2022)
  • 0.20.0 (January 2022)
  • 0.19.0 (November 2021)
  • 0.18.0 (October 2021)
  • 0.17.0 (September 2021)
  • 0.16.0 (September 2021)
  • 0.15.1 (unreleased)
  • 0.15.0 (July 2021)
  • 0.14.0 (June 2021)
  • 0.13.1 (unreleased)
  • 0.13.0 (May 2021)
  • 0.12.0 (May 2021)

pytket documentation:

• pytket API docs
• pytket extensions
• Manual
• Example notebooks
• TKET website

Links:

• bug tracker
• GitHub
• PyPi