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.8.tar.gz (33.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.8-py3-none-any.whl (38.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: skq-0.3.8.tar.gz
  • Upload date:
  • Size: 33.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.8.tar.gz
Algorithm Hash digest
SHA256 dd5199b02e0ebb3080799cb0cccdf110778c7f1b4ff16d96fe4eae8baeb9d4a0
MD5 d3df03fba58b9a113174cc65a207a440
BLAKE2b-256 9214b9ca62a6d632cf41001a72009590b4f4a8e2fee805b3bc0b9c3806c3a2b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: skq-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 38.4 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c4f699c72f673727f9e93f0b67625db582a9ebcab47e258504c9be69417c7b4a
MD5 6330db166bba01e446f536c48dd558f9
BLAKE2b-256 f75888b6f6bed8af543de82d51679372e4bd70d288956b85497930e48a23ab1d

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