QuKit

Quantum Kit in Swift framework.

Xiao Shang

Welcome to QuKit

QuKit is a Swift library for interacting with quantum physics, which makes programming simple things easy, and difficult things possible. It is inspired by the Quantum Optics Toolbox for MATLAB, the Python framework QuTiP, and the Julia Framework for Open Quantum Dynamics.

To learn more about the library, visit qukit.org.

• Getting Started
• Usage
• Swift Package Manager
• Learning More
• Notes

Contributing to QuKit

Contributions to QuKit are welcomed and encouraged! Please see the Contributing to Qukit guide.

Getting Started

Usage

import qukit

Swift Package Manager

Add the following dependency to your Package.swift manifest:

.package(url: "https://github.com/iqukit/qukit.git", .branch("main")),

Namely,

import PackageDescription

let package = Package(
    name: "MyPackage",
    dependencies: [
        .package(url: "https://github.com/iqukit/qukit.git", .branch("main")),
    ],
    targets: [
        .target(
            name: "MyPackage",
            dependencies: ["qukit"]
        ),
        .testTarget(
            name: "MyPackageTests",
            dependencies: ["MyPackage"]
        ),
    ]
)

Now you should be able to import qukit in the MyPackage target.

Learning More

Be sure to look at the documentation index for a bird's eye view of the available documentation.

Notes