Skip to main content

Ket quantum programming language interpreter and library

Project description

PyPI Contributor Covenant REUSE status

Ket Quantum Programming

[[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.8 or newer and is available for Linux, Windows, and macOS. If you are not using x86_64 (example ARM), you must 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.75 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.0b3.tar.gz (93.5 kB view details)

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

ket_lang-0.8.0b3-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.0b3-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.0b3.tar.gz.

File metadata

  • Download URL: ket_lang-0.8.0b3.tar.gz
  • Upload date:
  • Size: 93.5 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.0b3.tar.gz
Algorithm Hash digest
SHA256 b24e09d47933e180cf68445a622b88ffad3536e4e2ccac9b7e6e4e8caed07ef5
MD5 9be8d6191cb1ea177e6e07b9ca28f76c
BLAKE2b-256 aa20eb406a5b66e37444b91f38419be053e44b122ad6376b62119f0c74c31ccc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ket_lang-0.8.0b3-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.0b3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0a2899177ac01c1f0fb241c7fade76d3690dcb58808fabcbe389fafa55cb63a9
MD5 d96e50c8eaa0ccb2d4ab54cb6bf34903
BLAKE2b-256 c76ea59b3b753a42127a22b79ea73a1db5e208f5f38d22e35bdf23f87dcd3523

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ket_lang-0.8.0b3-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 7e1277526b593469b4b0cf74fa1b28de7badfbeb0e2433196e7d2cd52843fc70
MD5 9fc4a45a27baa2e2ae30d56714e6caf6
BLAKE2b-256 29c7df625073786a105bf26a0ba09ddf0602d541c555bace99d48bbe9b56de97

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ket_lang-0.8.0b3-py3-none-macosx_10_14_universal2.whl
Algorithm Hash digest
SHA256 352a97756462e3237770e29177dda73e0063f9940276571b275141fab735dec9
MD5 c28e69ab4049849ae09b33f65502bf30
BLAKE2b-256 f12e4208d4055ca600b66eaa76b5253d8795a43cd6c90f67ed8eae9fad067582

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