This release is a pre-release and may not be stable for production use.
Ket Quantum Programming
Ket is an embedded programming language that introduces the ease of Python to quantum programming, letting anyone quickly prototype and test a quantum application.
Python is the most widely used programming language for machine learning and data science and has been the language of choice for quantum programming. Ket is a Python-embedded language, but many can use it as a Python library in most cases. So you can use Ket together with NumPy, SciPy, Pandas, and other popular Python libraries.
Ket's goal is to streamline the development of hardware-independent classical quantum applications by providing transparent interaction of classical and quantum data. See https://quantumket.org to learn more about Ket.
Installation ⬇️
Ket requires Python 3.10 or newer and is available for Linux, Windows, and macOS (both Apple silicon and Intel). If you are using a non-x86_64 (Intel/AMD) CPU, such as ARM, on Linux or Windows, you will need to install Rust before installing Ket.
You can install Ket using pip. To do so, copy and paste the following command into your terminal:
pip install ket-lang
Documentation 📜
Documentation available at https://quantumket.org.
Examples 💡
Grover's Algorithm
import ket
from math import sqrt, pi
def grover(size: int, oracle) -> int:
p = ket.Process(simulator="dense", num_qubits=size)
s = ket.H(p.alloc(size))
steps = int((pi / 4) * sqrt(2**size))
for _ in range(steps):
oracle(s)
with ket.around(ket.cat(ket.H, ket.X), s):
ket.CZ(*s)
return ket.measure(s).value
size = 8
looking_for = 13
print(grover(size, ket.qulib.oracle.phase_oracle(looking_for)))
# 13
Quantum Teleportation
import ket
def bell(qubits):
"""Prepare a Bell (maximally entangled) pair."""
return ket.ctrl(ket.H(qubits[0]), ket.X)(qubits[1])
def teleport(alice_msg, alice_aux, bob_aux):
"""Teleport the quantum state of alice_msg to bob_aux."""
ket.ctrl(alice_msg, ket.X)(alice_aux)
ket.H(alice_msg)
m0 = ket.measure(alice_msg)
m1 = ket.measure(alice_aux)
if m1.value == 1:
ket.X(bob_aux)
if m0.value == 1:
ket.Z(bob_aux)
return bob_aux
p = ket.Process(execution="live")
alice = p.alloc() # alice = |0⟩
ket.H(alice) # alice = |+⟩
ket.Z(alice) # alice = |–⟩
bob = teleport(alice, *bell(p.alloc(2))) # bob ← alice
ket.H(bob) # bob = |1⟩
print("Expected measure 1, result =", ket.measure(bob).value)
# Expected measure 1, result = 1
Setup for Ket Development 🔨
To get started with Ket development, follow these steps:
-
Rust Installation
Ensure that Rust is installed on your system. If not, follow the Rust install guide.
Important: For Rust development, make sure to use the exact same rustc version as the current ket distribution. This version-matching is not required if you are developing with Python or C FFI.
-
Clone and Compile
Clone the Ket repository and compile the Rust libraries:
git clone --recursive https://gitlab.com/quantum-ket/ket.git cd ket cargo build -F c_api --manifest-path src/ket/clib/libs/libket/Cargo.toml cargo build --manifest-path src/ket/clib/libs/kbw/Cargo.toml # Create symlinks from within the libs directory ln -s libket/target/debug/libket.so src/ket/clib/libs/libket.so ln -s kbw/target/debug/libkbw.so src/ket/clib/libs/libkbw.so
-
Set Up Virtual Environment
Set up a virtual environment for Python:
python3 -m venv venv source venv/bin/activate
-
Install Dependencies
Upgrade pip and install development requirements:
pip install -U pip pip install -r requirements_dev.txt
-
Install Ket
Install Ket in editable mode:
pip install -e .
-
Run Tests
To ensure everything is correctly installed, run the tests:
pytest
You're now set up for Ket development! Happy coding! 🚀
Cite Ket 📖
When using Ket for research projects, please cite:
Evandro Chagas Ribeiro da Rosa and Rafael de Santiago. 2021. Ket Quantum Programming. J. Emerg. Technol. Comput. Syst. 18, 1, Article 12 (January 2022), 25 pages. DOI: 10.1145/3474224
@article{ket,
author = {Evandro Chagas Ribeiro da Rosa and Rafael de Santiago},
title = {Ket Quantum Programming},
year = {2021},
issue_date = {January 2022},
publisher = {Association for Computing Machinery},
address = {New York, NY, USA},
volume = {18},
number = {1},
issn = {1550-4832},
url = {https://doi.org/10.1145/3474224},
doi = {10.1145/3474224},
journal = {J. Emerg. Technol. Comput. Syst.},
month = oct,
articleno = {12},
numpages = {25},
keywords = {Quantum programming, cloud quantum computation, qubit simulation}
}
1 maintainer
Release files for ket-lang 0.10.4.dev1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ket_lang-0.10.4.dev1.tar.gz | 220.0 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ket_lang-0.10.4.dev1-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details |
| ket_lang-0.10.4.dev1-py3-none-manylinux_2_28_x86_64.whl | Python 3 | none | Linux glibc 2.28+ x86-64 | Details |
| ket_lang-0.10.4.dev1-py3-none-macosx_14_0_universal2.whl | Python 3 | none | macOS 14.0+ universal2 (ARM64, x86-64) | Details |
Total release size: 19.9 MB
Release files / ket_lang-0.10.4.dev1.tar.gz
| Download URL | ket_lang-0.10.4.dev1.tar.gz |
|---|---|
| Size | 220.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2ab10b7aca57ce7a28ca1150e0e15ef4c871868a438ccd4f34a6cc215342361f
|
|
BLAKE2b-256 checksum How to use checksums |
9ec6c1064267dd6361363f11c3d2a058d3b75811f814d6729197c29c07081e3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.21
|
Release files / ket_lang-0.10.4.dev1-py3-none-win_amd64.whl
| Download URL | ket_lang-0.10.4.dev1-py3-none-win_amd64.whl |
|---|---|
| Size | 6.9 MB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
f9890a21c9560d8c749954f08a2e89cab049b9f4b8db068f96522769a51d6bd8
|
|
BLAKE2b-256 checksum How to use checksums |
5872e1e3be58f8ce8013cf7b5e0af62198736880f0857388722defab6cae6f61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.21
|
Release files / ket_lang-0.10.4.dev1-py3-none-manylinux_2_28_x86_64.whl
| Download URL | ket_lang-0.10.4.dev1-py3-none-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 4.6 MB |
| Tags | Linux glibc 2.28+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
44ca6daf6f3a92f444b92c3bce91a68d40e7ee5695ed545c070f8962953a1b8d
|
|
BLAKE2b-256 checksum How to use checksums |
da360550765ebb129a7e6c3aefe382df8a0d0181534b29dd8d03d273d64829ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.21
|
Release files / ket_lang-0.10.4.dev1-py3-none-macosx_14_0_universal2.whl
| Download URL | ket_lang-0.10.4.dev1-py3-none-macosx_14_0_universal2.whl |
|---|---|
| Size | 8.1 MB |
| Tags | Python 3 macOS 14.0+ universal2 (ARM64, x86-64) |
|
SHA-256 checksum How to use checksums |
953803e9dd46d437a1318ce5162494b4ebfd72a0e4f4f8f22b3c970e5156812a
|
|
BLAKE2b-256 checksum How to use checksums |
c44205b992296a5964ec2b44a5442c4348302a88a748f1929fec835de3fc7541
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
