Metadata-Version: 2.1
Name: equilux
Version: 0.1.0
License: Apache 2.0
Project-URL: Homepage, https://github.com/OpenQuantumDesign/equilux
Project-URL: Documentation, https://docs.openquantumdesign.org
Project-URL: Repository, https://github.com/OpenQuantumDesign/equilux.git
Project-URL: Issues, https://github.com/OpenQuantumDesign/equilux/issues
Keywords: quantum,computing,analog,digitial,atomic,simulation,full-stack
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research 
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: matplotlib
Requires-Dist: seaborn
Requires-Dist: oqd-compiler-infrastructure
Requires-Dist: oqd-core
Requires-Dist: oqd-analog-emulator
Requires-Dist: oqd-cloud
Provides-Extra: docs
Requires-Dist: pymdown-extensions; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: mdx-truly-sane-lists; extra == "docs"
Requires-Dist: jupyter==1.1.1; extra == "docs"
Requires-Dist: jupyter-contrib-nbextensions==0.7.0; extra == "docs"
Requires-Dist: mkdocs-jupyter==0.25.0; extra == "docs"
Requires-Dist: mkdocs-monorepo-plugin; extra == "docs"
Requires-Dist: notebook==6.4.12; extra == "docs"
Provides-Extra: test
Requires-Dist: unittest-prettify; extra == "test"

# ![Open Quantum Design](https://raw.githubusercontent.com/OpenQuantumDesign/oqd-compiler-infrastructure/main/docs/img/oqd-logo-text.png)

<h2 align="center">
    Program the world's first open-source, full-stack quantum computer.
</h2>

[![doc](https://img.shields.io/badge/documentation-lightblue)](https://docs.openquantumdesign.org/)
[![PyPI Version](https://img.shields.io/pypi/v/equilux)](https://pypi.org/project/equilux)
[![ci](https://github.com/OpenQuantumDesign/equilux/actions/workflows/deploy_docs.yaml/badge.svg)](https://github.com/OpenQuantumDesign/equilux/actions/workflows/deploy_docs.yaml)
![versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0)

## About
Open Quantum Design (OQD) is a non-profit foundation supporting the development of full-stack, open-source quantum computers.
OQD's current designs are based on laser-cooled trapped ion quantum computing hardware, including real-time control, backend and frontend software.
This documentation covers the software components of the OQD stack, including the core programming interfaces,
classical emulation backends, compiler infrastructure, and cloud server containers.

`equilux` is the top-level package to access the full OQD software suite in a single place.

## What's here

- [Quick Start](#quickstart) <br/>
- [Installation](#installation) <br/>
- [The Stack](#stack) <br/>
- [Software](#software) <br/>
- [Hardware](#hardware) <br/>
- [Documentation](#documentation) <br/>

## Quick start <a name="quickstart"></a>

## Installation <a name="installation"></a>
To install `equilux` and the suite Open Quantum Design software tools,  
```bash
pip install equilux
```

Alternatively, the repository can be cloned and installed locally,
```bash
git clone https://github.com/OpenQuantumDesign/equilux
pip install .
```

## The stack <a name="stack"></a>


Open Quantum Design's quantum computing stack can be interfaced at different levels, including the digital, analog, and atomic layers.
```mermaid
block-beta
   columns 3
   
   block:Interface
       columns 1
       InterfaceTitle("<i><b>Interfaces</b><i/>")
       InterfaceDigital["<b>Digital Interface</b>\nQuantum circuits with discrete gates"] 
       space
       InterfaceAnalog["<b>Analog Interface</b>\n Continuous-time evolution with Hamiltonians"] 
       space
       InterfaceAtomic["<b>Atomic Interface</b>\nLight-matter interactions between lasers and ions"]
       space
    end
    
    block:IR
       columns 1
       IRTitle("<i><b>IRs</b><i/>")
       IRDigital["Quantum circuit IR\nopenQASM, LLVM+QIR"] 
       space
       IRAnalog["openQSIM"]
       space
       IRAtomic["openAPL"]
       space
    end
    
    block:Emulator
       columns 1
       EmulatorsTitle("<i><b>Classical Emulators</b><i/>")
       
       EmulatorDigital["Pennylane, Qiskit"] 
       space
       EmulatorAnalog["QuTiP, QuantumOptics.jl"]
       space
       EmulatorAtomic["TrICal, QuantumIon.jl"]
       space
    end
    
    space
    block:RealTime
       columns 1
       RealTimeTitle("<i><b>Real-Time</b><i/>")
       space
       RTSoftware["ARTIQ, DAX, OQDAX"] 
       space
       RTGateware["Sinara Real-Time Control"]
       space
       RTHardware["Lasers, Modulators, Photodetection, Ion Trap"]
       space
       RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yt<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
       space
    end
    space
    
   InterfaceDigital --> IRDigital
   InterfaceAnalog --> IRAnalog
   InterfaceAtomic --> IRAtomic
   
   IRDigital --> IRAnalog
   IRAnalog --> IRAtomic
   
   IRDigital --> EmulatorDigital
   IRAnalog --> EmulatorAnalog
   IRAtomic --> EmulatorAtomic
   
   IRAtomic --> RealTimeTitle
   
   RTSoftware --> RTGateware
   RTGateware --> RTHardware
   RTHardware --> RTApparatus
   
    classDef title fill:#d6d4d4,stroke:#333,color:#333;
    classDef digital fill:#E7E08B,stroke:#333,color:#333;
    classDef analog fill:#E4E9B2,stroke:#333,color:#333;
    classDef atomic fill:#D2E4C4,stroke:#333,color:#333;
    classDef realtime fill:#B5CBB7,stroke:#333,color:#333;

    classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
    
    class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
    class InterfaceDigital,IRDigital,EmulatorDigital digital
    class InterfaceAnalog,IRAnalog,EmulatorAnalog analog
    class InterfaceAtomic,IRAtomic,EmulatorAtomic atomic
    class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
```

### Software <a name="software"></a>
OQD's software stack components include Python interfaces at the digital, analog, and atomic layers, 
classical emulators, compiler infrastructure, and cloud server components. 

### Hardware <a name="hardware"></a>

Planned supported hardware backends include 
the [Bloodstone](docs/hardware/devices.md) processor based on<sup>171</sup>Yb<sup>+</sup> ions
and the [Beryl](docs/hardware/devices.md) processor based on<sup>133</sup>Ba<sup>+</sup> ions.



## Getting started <a name="Getting Started"></a>
Below is a short example of how to use the analog interface to specify, serialize, 
and simulate an analog quantum program - here, a single-qubit Rabi-flopping experiment.

```python
from oqd_core.interface.analog.operator import PauliZ, PauliX
from oqd_core.interface.analog.operation import AnalogCircuit, AnalogGate
from oqd_core.backend.metric import Expectation
from oqd_core.backend.task import Task, TaskArgsAnalog
from oqd_analog_emulator.qutip_backend import QutipBackend

X = PauliX()
Z = PauliZ()

Hx = AnalogGate(hamiltonian=X)

circuit = AnalogCircuit()
circuit.evolve(duration=10, gate=Hx)
circuit.measure()

args = TaskArgsAnalog(
  n_shots=100,
  fock_cutoff=4,
  metrics={"Z": Expectation(operator=Z)},
  dt=1e-3,
)

task = Task(program=circuit, args=args)

backend = QutipBackend()
results = backend.run(task=task)
```

## Documentation <a name="documentation"></a>
Documentation can be found at [docs.openquantumdesign.org](https://docs.openquantumdesign.org/en/latest/).
