Skip to main content

Ket quantum programming language interpreter and library

Project description

Ket Quantum Programming

PyPI Contributor Covenant REUSE status

[[TOC]]

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, ScyPy, 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 :arrow_down:

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 :scroll:

Documentation available at https://quantumket.org.

Examples :bulb:

Grover's Algorithm

from ket import *
from math import sqrt, pi


def grover(n: int, oracle) -> int:
    p = Process()
    qubits = H(p.alloc(n))
    steps = int((pi / 4) * sqrt(2**n))
    for _ in range(steps):
        oracle(qubits)
        with around(H, qubits):
            phase_oracle(0, qubits)
    return measure(qubits).value


n = 8
looking_for = 13
print(grover(n, phase_oracle(looking_for)))
# 13

Quantum Teleportation

from ket import *


def entangle(a: Quant, b: Quant):
    return CNOT(H(a), b)


def teleport(quantum_message: Quant, entangled_qubit: Quant):
    adj(entangle)(quantum_message, entangled_qubit)
    return measure(entangled_qubit).value, measure(quantum_message).value


def decode(classical_message: tuple[int, int], qubit: Quant):
    if classical_message[0] == 1:
        X(qubit)

    if classical_message[1] == 1:
        Z(qubit)


if __name__ == "__main__":
    from math import pi

    p = Process()

    alice_message = P(pi / 4, H(p.alloc()))

    alice_message_dump = dump(alice_message)

    alice_qubit, bob_qubit = entangle(*p.alloc(2))

    classical_message = teleport(
        quantum_message=alice_message, entangled_qubit=alice_qubit
    )

    decode(classical_message, bob_qubit)

    bob_qubit_dump = dump(bob_qubit)

    print("Alice Message:")
    print(alice_message_dump.show())

    print("Bob Qubit:")
    print(bob_qubit_dump.show())
# Alice Message:
# |0⟩     (50.00%)
#  0.707107               ≅      1/√2
# |1⟩     (50.00%)
#  0.500000+0.500000i     ≅  (1+i)/√4
# Bob Qubit:
# |0⟩     (50.00%)
#  0.707107               ≅      1/√2
# |1⟩     (50.00%)
#  0.500000+0.500000i     ≅  (1+i)/√4

Setup for Ket Development :hammer:

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. After installation, set the Rust version to 1.88 using the following command:

    rustup default 1.88
    
  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 --manifest-path src/ket/clib/libs/libket/Cargo.toml
    cargo build --manifest-path src/ket/clib/libs/kbw/Cargo.toml
    
    ln -s libket/target/debug/libket.so src/ket/clib/libs
    ln -s kbw/target/debug/libkbw.so src/ket/clib/libs
    
  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 .[full]
    
  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 :book:

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}
}

Project details


Release history Release notifications | RSS feed

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.9.2.tar.gz (129.7 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.9.2-py3-none-win_amd64.whl (7.2 MB view details)

Uploaded Python 3Windows x86-64

ket_lang-0.9.2-py3-none-manylinux_2_28_x86_64.whl (4.0 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

ket_lang-0.9.2-py3-none-macosx_14_0_universal2.whl (6.8 MB view details)

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

File details

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

File metadata

  • Download URL: ket_lang-0.9.2.tar.gz
  • Upload date:
  • Size: 129.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for ket_lang-0.9.2.tar.gz
Algorithm Hash digest
SHA256 b8cc2cfdb36417132dd5377fe42d497dbd3aeccb46e6bff1e2bca35e3353acf5
MD5 3f45bd269217063ab319b3bb25e9c9a1
BLAKE2b-256 4b6d8e626285a7b5f0c808b62f0ee2fe33b02d16b0fcd4b21c060305ae7b0435

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ket_lang-0.9.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 ab368f272029d464a603622c2e08618f6b3832ef356ea22565b35b254b9a04af
MD5 83d3a70fc90954022c299209a16baaf8
BLAKE2b-256 1fdc5f4101f6a4798e25f63182c5d5a8eb796223b1778edda60b635a79eaa745

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ket_lang-0.9.2-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 24365899c4515cb188d8663af6b62903de980fdf186f3de1f0328e58784ce65c
MD5 e62a4924d6c35aaed3c7e00d08b9fae4
BLAKE2b-256 8debf7ecfc83f4855d0e3165e04d733e6decfb5a6eb5cabfafd88bab312b2add

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ket_lang-0.9.2-py3-none-macosx_14_0_universal2.whl
Algorithm Hash digest
SHA256 efd003b52487a21065387ee43a2a38ce28453ae7bd683b015cfc24cf1ea144dc
MD5 017eae5d416aebe4d93b9bb49178596a
BLAKE2b-256 4b9cef52e57ac522b00cd7bdf6248a134bd1a712576485633c18d562bb3a2560

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