pytket-cirq

Cirq is a python library for producing quantum circuits and running them on simulators and physical quantum devices.

pytket-cirq is an extension to pytket that allows conversion to and from Cirq representations.

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

pip install pytket-cirq

• API documentation
  • cirq_to_tk()
  • process_characterisation()
  • tk_to_cirq()
  • CirqStateSampleBackend
    • CirqStateSampleBackend.available_devices()
    • CirqStateSampleBackend.cancel()
    • CirqStateSampleBackend.circuit_status()
    • CirqStateSampleBackend.default_compilation_pass()
    • CirqStateSampleBackend.empty_cache()
    • CirqStateSampleBackend.get_compiled_circuit()
    • CirqStateSampleBackend.get_compiled_circuits()
    • CirqStateSampleBackend.get_result()
    • CirqStateSampleBackend.get_results()
    • CirqStateSampleBackend.pop_result()
    • CirqStateSampleBackend.process_circuit()
    • CirqStateSampleBackend.process_circuits()
    • CirqStateSampleBackend.rebase_pass()
    • CirqStateSampleBackend.run_circuit()
    • CirqStateSampleBackend.run_circuits()
    • CirqStateSampleBackend.valid_circuit()
    • CirqStateSampleBackend.backend_info
    • CirqStateSampleBackend.expectation_allows_nonhermitian
    • CirqStateSampleBackend.persistent_handles
    • CirqStateSampleBackend.required_predicates
    • CirqStateSampleBackend.supports_contextual_optimisation
    • CirqStateSampleBackend.supports_counts
    • CirqStateSampleBackend.supports_density_matrix
    • CirqStateSampleBackend.supports_expectation
    • CirqStateSampleBackend.supports_shots
    • CirqStateSampleBackend.supports_state
    • CirqStateSampleBackend.supports_unitary
  • CirqDensityMatrixSampleBackend
    • CirqDensityMatrixSampleBackend.available_devices()
    • CirqDensityMatrixSampleBackend.cancel()
    • CirqDensityMatrixSampleBackend.circuit_status()
    • CirqDensityMatrixSampleBackend.default_compilation_pass()
    • CirqDensityMatrixSampleBackend.empty_cache()
    • CirqDensityMatrixSampleBackend.get_compiled_circuit()
    • CirqDensityMatrixSampleBackend.get_compiled_circuits()
    • CirqDensityMatrixSampleBackend.get_result()
    • CirqDensityMatrixSampleBackend.get_results()
    • CirqDensityMatrixSampleBackend.pop_result()
    • CirqDensityMatrixSampleBackend.process_circuit()
    • CirqDensityMatrixSampleBackend.process_circuits()
    • CirqDensityMatrixSampleBackend.rebase_pass()
    • CirqDensityMatrixSampleBackend.run_circuit()
    • CirqDensityMatrixSampleBackend.run_circuits()
    • CirqDensityMatrixSampleBackend.valid_circuit()
    • CirqDensityMatrixSampleBackend.backend_info
    • CirqDensityMatrixSampleBackend.expectation_allows_nonhermitian
    • CirqDensityMatrixSampleBackend.persistent_handles
    • CirqDensityMatrixSampleBackend.required_predicates
    • CirqDensityMatrixSampleBackend.supports_contextual_optimisation
    • CirqDensityMatrixSampleBackend.supports_counts
    • CirqDensityMatrixSampleBackend.supports_density_matrix
    • CirqDensityMatrixSampleBackend.supports_expectation
    • CirqDensityMatrixSampleBackend.supports_shots
    • CirqDensityMatrixSampleBackend.supports_state
    • CirqDensityMatrixSampleBackend.supports_unitary
  • CirqCliffordSampleBackend
    • CirqCliffordSampleBackend.available_devices()
    • CirqCliffordSampleBackend.cancel()
    • CirqCliffordSampleBackend.circuit_status()
    • CirqCliffordSampleBackend.default_compilation_pass()
    • CirqCliffordSampleBackend.empty_cache()
    • CirqCliffordSampleBackend.get_compiled_circuit()
    • CirqCliffordSampleBackend.get_compiled_circuits()
    • CirqCliffordSampleBackend.get_result()
    • CirqCliffordSampleBackend.get_results()
    • CirqCliffordSampleBackend.pop_result()
    • CirqCliffordSampleBackend.process_circuit()
    • CirqCliffordSampleBackend.process_circuits()
    • CirqCliffordSampleBackend.rebase_pass()
    • CirqCliffordSampleBackend.run_circuit()
    • CirqCliffordSampleBackend.run_circuits()
    • CirqCliffordSampleBackend.valid_circuit()
    • CirqCliffordSampleBackend.backend_info
    • CirqCliffordSampleBackend.expectation_allows_nonhermitian
    • CirqCliffordSampleBackend.persistent_handles
    • CirqCliffordSampleBackend.required_predicates
    • CirqCliffordSampleBackend.supports_contextual_optimisation
    • CirqCliffordSampleBackend.supports_counts
    • CirqCliffordSampleBackend.supports_density_matrix
    • CirqCliffordSampleBackend.supports_expectation
    • CirqCliffordSampleBackend.supports_shots
    • CirqCliffordSampleBackend.supports_state
    • CirqCliffordSampleBackend.supports_unitary
  • CirqStateSimBackend
    • CirqStateSimBackend.available_devices()
    • CirqStateSimBackend.cancel()
    • CirqStateSimBackend.circuit_status()
    • CirqStateSimBackend.default_compilation_pass()
    • CirqStateSimBackend.empty_cache()
    • CirqStateSimBackend.get_compiled_circuit()
    • CirqStateSimBackend.get_compiled_circuits()
    • CirqStateSimBackend.get_result()
    • CirqStateSimBackend.get_results()
    • CirqStateSimBackend.package_result()
    • CirqStateSimBackend.package_results()
    • CirqStateSimBackend.pop_result()
    • CirqStateSimBackend.process_circuit()
    • CirqStateSimBackend.process_circuit_moments()
    • CirqStateSimBackend.process_circuits()
    • CirqStateSimBackend.process_circuits_moments()
    • CirqStateSimBackend.rebase_pass()
    • CirqStateSimBackend.run_circuit()
    • CirqStateSimBackend.run_circuits()
    • CirqStateSimBackend.valid_circuit()
    • CirqStateSimBackend.backend_info
    • CirqStateSimBackend.expectation_allows_nonhermitian
    • CirqStateSimBackend.persistent_handles
    • CirqStateSimBackend.required_predicates
    • CirqStateSimBackend.supports_contextual_optimisation
    • CirqStateSimBackend.supports_counts
    • CirqStateSimBackend.supports_density_matrix
    • CirqStateSimBackend.supports_expectation
    • CirqStateSimBackend.supports_shots
    • CirqStateSimBackend.supports_state
    • CirqStateSimBackend.supports_unitary
  • CirqDensityMatrixSimBackend
    • CirqDensityMatrixSimBackend.available_devices()
    • CirqDensityMatrixSimBackend.cancel()
    • CirqDensityMatrixSimBackend.circuit_status()
    • CirqDensityMatrixSimBackend.default_compilation_pass()
    • CirqDensityMatrixSimBackend.empty_cache()
    • CirqDensityMatrixSimBackend.get_compiled_circuit()
    • CirqDensityMatrixSimBackend.get_compiled_circuits()
    • CirqDensityMatrixSimBackend.get_result()
    • CirqDensityMatrixSimBackend.get_results()
    • CirqDensityMatrixSimBackend.package_result()
    • CirqDensityMatrixSimBackend.package_results()
    • CirqDensityMatrixSimBackend.pop_result()
    • CirqDensityMatrixSimBackend.process_circuit()
    • CirqDensityMatrixSimBackend.process_circuit_moments()
    • CirqDensityMatrixSimBackend.process_circuits()
    • CirqDensityMatrixSimBackend.process_circuits_moments()
    • CirqDensityMatrixSimBackend.rebase_pass()
    • CirqDensityMatrixSimBackend.run_circuit()
    • CirqDensityMatrixSimBackend.run_circuits()
    • CirqDensityMatrixSimBackend.valid_circuit()
    • CirqDensityMatrixSimBackend.backend_info
    • CirqDensityMatrixSimBackend.expectation_allows_nonhermitian
    • CirqDensityMatrixSimBackend.persistent_handles
    • CirqDensityMatrixSimBackend.required_predicates
    • CirqDensityMatrixSimBackend.supports_contextual_optimisation
    • CirqDensityMatrixSimBackend.supports_counts
    • CirqDensityMatrixSimBackend.supports_density_matrix
    • CirqDensityMatrixSimBackend.supports_expectation
    • CirqDensityMatrixSimBackend.supports_shots
    • CirqDensityMatrixSimBackend.supports_state
    • CirqDensityMatrixSimBackend.supports_unitary
  • CirqCliffordSimBackend
    • CirqCliffordSimBackend.available_devices()
    • CirqCliffordSimBackend.cancel()
    • CirqCliffordSimBackend.circuit_status()
    • CirqCliffordSimBackend.default_compilation_pass()
    • CirqCliffordSimBackend.empty_cache()
    • CirqCliffordSimBackend.get_compiled_circuit()
    • CirqCliffordSimBackend.get_compiled_circuits()
    • CirqCliffordSimBackend.get_result()
    • CirqCliffordSimBackend.get_results()
    • CirqCliffordSimBackend.package_result()
    • CirqCliffordSimBackend.package_results()
    • CirqCliffordSimBackend.pop_result()
    • CirqCliffordSimBackend.process_circuit()
    • CirqCliffordSimBackend.process_circuit_moments()
    • CirqCliffordSimBackend.process_circuits()
    • CirqCliffordSimBackend.process_circuits_moments()
    • CirqCliffordSimBackend.rebase_pass()
    • CirqCliffordSimBackend.run_circuit()
    • CirqCliffordSimBackend.run_circuits()
    • CirqCliffordSimBackend.valid_circuit()
    • CirqCliffordSimBackend.backend_info
    • CirqCliffordSimBackend.expectation_allows_nonhermitian
    • CirqCliffordSimBackend.persistent_handles
    • CirqCliffordSimBackend.required_predicates
    • CirqCliffordSimBackend.supports_contextual_optimisation
    • CirqCliffordSimBackend.supports_counts
    • CirqCliffordSimBackend.supports_density_matrix
    • CirqCliffordSimBackend.supports_expectation
    • CirqCliffordSimBackend.supports_shots
    • CirqCliffordSimBackend.supports_state
    • CirqCliffordSimBackend.supports_unitary
• Changelog
  • 0.36.0 (April 2024)
  • 0.35.0 (March 2024)
  • 0.34.0 (January 2024)
  • 0.33.0 (January 2024)
  • 0.32.0 (November 2023)
  • 0.31.1 (November 2023)
  • 0.31.0 (October 2023)
  • 0.30.0 (September 2023)
  • 0.29.0 (June 2023)
  • 0.28.0 (November 2022)
  • 0.27.1 (October 2022)
  • 0.27.0 (October 2022)
  • 0.26.0 (August 2022)
  • 0.25.0 (July 2022)
  • 0.24.0 (June 2022)
  • 0.23.0 (May 2022)
  • 0.22.0 (April 2022)
  • 0.21.0 (March 2022)
  • 0.20.0 (February 2022)
  • 0.19.0 (January 2022)
  • 0.18.0 (November 2021)
  • 0.17.0 (October 2021)
  • 0.16.0 (September 2021)
  • 0.15.0 (September 2021)
  • 0.14.0 (July 2021)
  • 0.13.0 (June 2021)
  • 0.12.0 (May 2021)
  • 0.11.0 (unreleased)
  • 0.10.1 (May 2021)
  • 0.10.0 (April 2021)

pytket documentation:

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

Links:

• bug tracker
• GitHub
• PyPi