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.9 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 = PHASE(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.82 using the following command:

    rustup default 1.82
    
  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.8.0.tar.gz (93.8 kB view details)

Uploaded Source

Built Distributions

ket_lang-0.8.0-py3-none-win_amd64.whl (2.8 MB view details)

Uploaded Python 3 Windows x86-64

ket_lang-0.8.0-py3-none-manylinux_2_28_x86_64.whl (1.1 MB view details)

Uploaded Python 3 manylinux: glibc 2.28+ x86-64

ket_lang-0.8.0-py3-none-macosx_10_14_universal2.whl (1.9 MB view details)

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

File details

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

File metadata

  • Download URL: ket_lang-0.8.0.tar.gz
  • Upload date:
  • Size: 93.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for ket_lang-0.8.0.tar.gz
Algorithm Hash digest
SHA256 cb3819f35e033726c8abd7e9e69f6f24b93fe1ec686580705e773a7224964b7f
MD5 777e0536f722ebce853697fba9a84149
BLAKE2b-256 cca5e269c2971eb29bced9c9083f2560814d68c615dade5dc8ef42799db63096

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ket_lang-0.8.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 decfe0a7b0a6b3f7725e09bb90e83ad8e4438da5ed385db2bc92f1dde3b90aba
MD5 efbfc564eab20e11a398e18d7a113882
BLAKE2b-256 6a5bdf53dc2943e87dae0671783d1bd221d9f0a3e6439595a6b50f2fb601119a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ket_lang-0.8.0-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 945f1c18eda10c6e97712d2a41bfb0223235bd0479be22a5c8f60f577ab6f4c8
MD5 3daaa4d664949029ef689b0a27d51eff
BLAKE2b-256 7b45ff48d0c5498527cb71a3818371addb49c36cf87a9f0bb8d93358934300b8

See more details on using hashes here.

File details

Details for the file ket_lang-0.8.0-py3-none-macosx_10_14_universal2.whl.

File metadata

File hashes

Hashes for ket_lang-0.8.0-py3-none-macosx_10_14_universal2.whl
Algorithm Hash digest
SHA256 faba65a84e9a14e516a2e79d9359420b7ca40e7bd1afe390406ea0faf1202808
MD5 c5270a3451041ccce4d5c05676d28d70
BLAKE2b-256 3766fdfa283dd98ef0dfbb095166d49b9935d7a13dd52edc8c50c8b145a32edb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page