Skip to main content

Scientific Toolkit for Quantum Computing

Project description

skq

Python Version uv Ruff

Scientific Toolkit for Quantum Computing

This library is used in the q4p (Quantum Computing for Programmers) course.

NOTE: This library is developed for educational purposes. While we strive for correctness of everything, the code is provided as is and not guaranteed to be bug-free. For sensitive applications make sure you check computations.

Why SKQ?

  • Exploration: Play with fundamental quantum building blocks using NumPy.
  • Education: Learn quantum computing concepts and algorithms.
  • Integration: Combine classical components with quantum components.
  • Democratize quantum for Python programmers and data scientists: Develop quantum algorithms in your favorite environment and easily export to your favorite quantum computing platform for running on real quantum hardware.

Install

pip install -U skq

Quickstart

Circuit Conversion

Run this code snippet to initialize a Bell State and convert to Qiskit and OpenQASM.

from skq.circuits.entangled_states import BellStates

# Initialize Bell State skq Circuit
circuit = BellStates().get_bell_state(1)

# Conversion to Qiskit
qiskit_circuit = circuit.convert(framework="qiskit")
qiskit_circuit.draw()
#      ┌───┐     
# q_0: ┤ H ├──■──
#      └───┘┌─┴─┐
# q_1: ─────┤ X ├
#           └───┘

# Conversion to OpenQASM
qasm_circuit = circuit.convert(framework="qasm")
print(qasm_circuit)
# h q[0];
# cx q[0], q[1];

Circuits from scratch

You can also build your own custom circuits from scratch using individual gates.

from skq.gates import H, I, CX
from skq.circuits import Concat, Circuit

H() # Hadamard gate (NumPy array)
# H([[ 0.70710678+0.j,  0.70710678+0.j],
#    [ 0.70710678+0.j, -0.70710678+0.j]])

I() # Identity gate (NumPy array)
# I([[1.+0.j, 0.+0.j],
#    [0.+0.j, 1.+0.j]])

CX() # CNOT gate (NumPy array)
# CX([[1.+0.j, 0.+0.j, 0.+0.j, 0.+0.j],
#     [0.+0.j, 1.+0.j, 0.+0.j, 0.+0.j],
#     [0.+0.j, 0.+0.j, 0.+0.j, 1.+0.j],
#     [0.+0.j, 0.+0.j, 1.+0.j, 0.+0.j]])

# Initialize Bell State skq Circuit
circuit = Circuit([Concat([H(), I()]), CX()])

# Simulate circuit classically
state = np.array([1, 0, 0, 0]) # |00> state
circuit(state)
# array([0.70710678+0.j, 0, 0, 0.70710678+0.j])

# Conversion to Qiskit (Identity gates are removed)
qiskit_circuit = circuit.convert(framework="qiskit")
qiskit_circuit.draw()
#      ┌───┐     
# q_0: ┤ H ├──■──
#      └───┘┌─┴─┐
# q_1: ─────┤ X ├
#           └───┘

# Conversion to OpenQASM
qasm_circuit = circuit.convert(framework="qasm")
print(qasm_circuit)
# h q[0];
# cx q[0], q[1];

Project details


Download files

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

Source Distribution

skq-0.3.11.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

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

skq-0.3.11-py3-none-any.whl (39.5 kB view details)

Uploaded Python 3

File details

Details for the file skq-0.3.11.tar.gz.

File metadata

  • Download URL: skq-0.3.11.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for skq-0.3.11.tar.gz
Algorithm Hash digest
SHA256 273e9b85628237427bb4c6debe9f564658b5716cd3d141286a028a8b0fdd3cd7
MD5 859961d4ac0269cac36a67bba8c0ed93
BLAKE2b-256 389b711e2081f4f4f63b5b552e6b052377b62286a2d7d042b8b249c9e0cca508

See more details on using hashes here.

File details

Details for the file skq-0.3.11-py3-none-any.whl.

File metadata

  • Download URL: skq-0.3.11-py3-none-any.whl
  • Upload date:
  • Size: 39.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for skq-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 280f3a8df6117cb87425a7b1b29d4cf1ce06f09f9bfb4c16b3265d889741adee
MD5 fefc21ace83d0baad2aec0d8f322efdb
BLAKE2b-256 2632d445b019ffa45aab526a29b11a385b3f14e9f9e1ddddba4c43d20d1ae2d1

See more details on using hashes here.

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