Skip to main content

Ket Quantum Programming

PyPI Contributor Covenant REUSE status

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:

  1. 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.

  2. 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
    
  3. Set Up Virtual Environment

    Set up a virtual environment for Python:

    python3 -m venv venv
    source venv/bin/activate
    
  4. Install Dependencies

    Upgrade pip and install development requirements:

    pip install -U pip
    pip install -r requirements_dev.txt
    
  5. Install Ket

    Install Ket in editable mode:

    pip install -e .
    
  6. 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}
}

Download files

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

Source Distribution

ket_lang-0.10.2.tar.gz (215.5 kB view details)

Uploaded Source

Built Distributions

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

ket_lang-0.10.2-py3-none-win_amd64.whl (6.9 MB view details)

Uploaded Python 3Windows x86-64

ket_lang-0.10.2-py3-none-manylinux_2_28_x86_64.whl (4.6 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

ket_lang-0.10.2-py3-none-macosx_14_0_universal2.whl (8.1 MB view details)

Uploaded Python 3macOS 14.0+ universal2 (ARM64, x86-64)

File details

Details for the file ket_lang-0.10.2.tar.gz.

File metadata

  • Download URL: ket_lang-0.10.2.tar.gz
  • Upload date:
  • Size: 215.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.21

File hashes

Hashes for ket_lang-0.10.2.tar.gz
Algorithm Hash digest
SHA256 f59fd8e67490244a6cd928705ae3ba88c83102633dddd27832194332c0996c2f
MD5 5e3b9de80e28444eacfc99840c4d1719
BLAKE2b-256 3a23d9ab6c008a9f75d4e7c55b1ba450a62f8a858f26508a17e1b87277440369

See more details on using hashes here.

File details

Details for the file ket_lang-0.10.2-py3-none-win_amd64.whl.

File metadata

  • Download URL: ket_lang-0.10.2-py3-none-win_amd64.whl
  • Upload date:
  • Size: 6.9 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.21

File hashes

Hashes for ket_lang-0.10.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6d22f67a5d229111bad286f95436ec9114c7174b7dc17c0450fe7a6a583d17bb
MD5 66e0b1e57b9fdb7ffcba212e5c2b54b7
BLAKE2b-256 ab8ccabf6f428e43b0d4cd13f2fcdb33ab7d00d39eba8882772705387823fcca

See more details on using hashes here.

File details

Details for the file ket_lang-0.10.2-py3-none-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for ket_lang-0.10.2-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 97a2a54e6af6bdd4ab07c5426b14215df399ddf20ac25807df990a52b6e24e71
MD5 25cbf951771d27a339bc0af4e26fcbed
BLAKE2b-256 7d07b3a9ccecaaaf147ce16f3ad4bbef9107acea25ee82e9c79bc982dc9b2266

See more details on using hashes here.

File details

Details for the file ket_lang-0.10.2-py3-none-macosx_14_0_universal2.whl.

File metadata

File hashes

Hashes for ket_lang-0.10.2-py3-none-macosx_14_0_universal2.whl
Algorithm Hash digest
SHA256 519da934e8358a5a5213b1e21609d3730405930715f7165e75f6f01bb17d4a60
MD5 571a08e556411c54184a86fec9aad2b4
BLAKE2b-256 48e76ff9134244f775987902ddc59a7c24d41659a02e117958183e7ffa312f1a

See more details on using hashes here.

Release history Release notifications | RSS feed

0.10.3

4 files

This release

0.10.2 This release

4 files

0.10.1

4 files

0.10.0.post1

4 files

0.10.0

4 files

0.9.3.5.post1

4 files

0.9.3.5

4 files

0.9.3.4.post1

4 files

0.9.3.4

4 files

0.9.3.3

4 files

0.9.3.2

4 files

0.9.3.1

4 files

0.9.3

4 files

0.9.2.8

4 files

0.9.2.7

4 files

0.9.2.6

4 files

0.9.2.5

4 files

0.9.2.4

4 files

0.9.2.3

4 files

0.9.2.2

4 files

0.9.2.1

4 files

0.9.2

4 files

0.9.1.5

4 files

0.9.1.4

4 files

0.9.1.3

4 files

0.9.1.2

4 files

0.9.1.1

1 file

0.9.1

4 files

0.9.0

4 files

0.8.3

4 files

0.8.2

4 files

0.8.1

4 files

0.8.0

4 files

0.7.1

5 files

0.7

5 files

0.6.1

5 files

0.6

5 files

0.5.3

3 files

0.5.2

5 files

0.5.1

5 files

0.5.0.1

4 files

0.5.0

4 files

0.4.3

4 files

0.4.2

2 files

0.4.1.post1

2 files

0.4.1

1 file

0.4

1 file

0.3.3

1 file

0.3.2

1 file

0.3.1

1 file

0.3

1 file

0.2.1

5 files

0.2

5 files

0.1.1

6 files

0.1

6 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page