Skip to content

Commit 55e04c4

Browse files
[docs] Update stack visual and doc index
1 parent 65ef9e1 commit 55e04c4

2 files changed

Lines changed: 65 additions & 64 deletions

File tree

README.md

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -41,93 +41,99 @@ pip install .[docs]
4141
mkdocs serve
4242
```
4343

44-
44+
### Where in the stack
4545
```mermaid
4646
block-beta
4747
columns 3
48-
48+
4949
block:Interface
5050
columns 1
5151
InterfaceTitle("<i><b>Interfaces</b><i/>")
52-
InterfaceDigital["<b>Digital Interface</b>\nQuantum circuits with discrete gates"]
52+
InterfaceDigital["<b>Digital Interface</b>\nQuantum circuits with discrete gates"]
5353
space
54-
InterfaceAnalog["<b>Analog Interface</b>\n Continuous-time evolution with Hamiltonians"]
54+
InterfaceAnalog["<b>Analog Interface</b>\n Continuous-time evolution with Hamiltonians"]
5555
space
5656
InterfaceAtomic["<b>Atomic Interface</b>\nLight-matter interactions between lasers and ions"]
5757
space
5858
end
59-
59+
6060
block:IR
6161
columns 1
6262
IRTitle("<i><b>IRs</b><i/>")
63-
IRDigital["Quantum circuit IR\nopenQASM, LLVM+QIR"]
63+
IRDigital["Quantum circuit IR\nopenQASM, LLVM+QIR"]
6464
space
6565
IRAnalog["openQSIM"]
6666
space
6767
IRAtomic["openAPL"]
6868
space
6969
end
70-
70+
7171
block:Emulator
7272
columns 1
7373
EmulatorsTitle("<i><b>Classical Emulators</b><i/>")
74-
75-
EmulatorDigital["Pennylane, Qiskit"]
74+
75+
EmulatorDigital["Pennylane, Qiskit"]
7676
space
7777
EmulatorAnalog["QuTiP, QuantumOptics.jl"]
7878
space
7979
EmulatorAtomic["TrICal, QuantumIon.jl"]
8080
space
8181
end
82-
82+
8383
space
8484
block:RealTime
8585
columns 1
8686
RealTimeTitle("<i><b>Real-Time</b><i/>")
8787
space
88-
RTSoftware["ARTIQ, DAX, OQDAX"]
88+
RTSoftware["ARTIQ, DAX, OQDAX"]
8989
space
9090
RTGateware["Sinara Real-Time Control"]
9191
space
9292
RTHardware["Lasers, Modulators, Photodetection, Ion Trap"]
9393
space
94-
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yt<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
94+
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yb<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
9595
space
9696
end
9797
space
98-
98+
9999
InterfaceDigital --> IRDigital
100100
InterfaceAnalog --> IRAnalog
101101
InterfaceAtomic --> IRAtomic
102-
102+
103103
IRDigital --> IRAnalog
104104
IRAnalog --> IRAtomic
105-
105+
106106
IRDigital --> EmulatorDigital
107107
IRAnalog --> EmulatorAnalog
108108
IRAtomic --> EmulatorAtomic
109-
109+
110110
IRAtomic --> RealTimeTitle
111-
111+
112112
RTSoftware --> RTGateware
113113
RTGateware --> RTHardware
114114
RTHardware --> RTApparatus
115-
116-
classDef title fill:#d6d4d4,stroke:#333,color:#333;
117-
classDef digital fill:#E7E08B,stroke:#333,color:#333;
118-
classDef analog fill:#E4E9B2,stroke:#333,color:#333;
119-
classDef atomic fill:#D2E4C4,stroke:#333,color:#333;
120-
classDef realtime fill:#B5CBB7,stroke:#333,color:#333;
121-
122-
classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
123-
115+
116+
classDef title fill:#23627D,stroke:#141414,color:#FFFFFF;
117+
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
118+
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
119+
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
120+
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;
121+
122+
classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
123+
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;
124+
124125
class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
125126
class InterfaceDigital,IRDigital,EmulatorDigital digital
126127
class InterfaceAnalog,IRAnalog,EmulatorAnalog analog
127128
class InterfaceAtomic,IRAtomic,EmulatorAtomic atomic
128129
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
130+
131+
class Emulator highlight
132+
133+
class Interface normal
134+
class RealTime normal
135+
class IR normal
129136
130-
class Emulator highlight
131137
```
132138
The tools in this repository allow for self-hosting a server to run
133139
quantum programs on classical emulators, highlighted in the stack diagram in red.

docs/index.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -18,107 +18,102 @@
1818
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
1919

2020

21-
22-
<!-- prettier-ignore -->
23-
/// admonition | Note
24-
type: note
25-
Welcome to the Open Quantum Design.
26-
This documentation is still under development, we welcome contributions! © Open Quantum Design
27-
///
28-
29-
3021
## What's Here
3122
This repository contains the software needed to submit jobs to a remote, cloud server for classical simulations of quantum programs.
3223
In addition, it provides a Docker script to self-host a simulation server of the OQD emulator backends.
3324

34-
35-
3625
```mermaid
3726
block-beta
3827
columns 3
39-
28+
4029
block:Interface
4130
columns 1
4231
InterfaceTitle("<i><b>Interfaces</b><i/>")
43-
InterfaceDigital["<b>Digital Interface</b>\nQuantum circuits with discrete gates"]
32+
InterfaceDigital["<b>Digital Interface</b>\nQuantum circuits with discrete gates"]
4433
space
45-
InterfaceAnalog["<b>Analog Interface</b>\n Continuous-time evolution with Hamiltonians"]
34+
InterfaceAnalog["<b>Analog Interface</b>\n Continuous-time evolution with Hamiltonians"]
4635
space
4736
InterfaceAtomic["<b>Atomic Interface</b>\nLight-matter interactions between lasers and ions"]
4837
space
4938
end
50-
39+
5140
block:IR
5241
columns 1
5342
IRTitle("<i><b>IRs</b><i/>")
54-
IRDigital["Quantum circuit IR\nopenQASM, LLVM+QIR"]
43+
IRDigital["Quantum circuit IR\nopenQASM, LLVM+QIR"]
5544
space
5645
IRAnalog["openQSIM"]
5746
space
5847
IRAtomic["openAPL"]
5948
space
6049
end
61-
50+
6251
block:Emulator
6352
columns 1
6453
EmulatorsTitle("<i><b>Classical Emulators</b><i/>")
65-
66-
EmulatorDigital["Pennylane, Qiskit"]
54+
55+
EmulatorDigital["Pennylane, Qiskit"]
6756
space
6857
EmulatorAnalog["QuTiP, QuantumOptics.jl"]
6958
space
7059
EmulatorAtomic["TrICal, QuantumIon.jl"]
7160
space
7261
end
73-
62+
7463
space
7564
block:RealTime
7665
columns 1
7766
RealTimeTitle("<i><b>Real-Time</b><i/>")
7867
space
79-
RTSoftware["ARTIQ, DAX, OQDAX"]
68+
RTSoftware["ARTIQ, DAX, OQDAX"]
8069
space
8170
RTGateware["Sinara Real-Time Control"]
8271
space
8372
RTHardware["Lasers, Modulators, Photodetection, Ion Trap"]
8473
space
85-
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yt<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
74+
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yb<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
8675
space
8776
end
8877
space
89-
78+
9079
InterfaceDigital --> IRDigital
9180
InterfaceAnalog --> IRAnalog
9281
InterfaceAtomic --> IRAtomic
93-
82+
9483
IRDigital --> IRAnalog
9584
IRAnalog --> IRAtomic
96-
85+
9786
IRDigital --> EmulatorDigital
9887
IRAnalog --> EmulatorAnalog
9988
IRAtomic --> EmulatorAtomic
100-
89+
10190
IRAtomic --> RealTimeTitle
102-
91+
10392
RTSoftware --> RTGateware
10493
RTGateware --> RTHardware
10594
RTHardware --> RTApparatus
106-
107-
classDef title fill:#d6d4d4,stroke:#333,color:#333;
108-
classDef digital fill:#E7E08B,stroke:#333,color:#333;
109-
classDef analog fill:#E4E9B2,stroke:#333,color:#333;
110-
classDef atomic fill:#D2E4C4,stroke:#333,color:#333;
111-
classDef realtime fill:#B5CBB7,stroke:#333,color:#333;
112-
113-
classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
114-
95+
96+
classDef title fill:#23627D,stroke:#141414,color:#FFFFFF;
97+
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
98+
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
99+
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
100+
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;
101+
102+
classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
103+
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;
104+
115105
class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
116106
class InterfaceDigital,IRDigital,EmulatorDigital digital
117107
class InterfaceAnalog,IRAnalog,EmulatorAnalog analog
118108
class InterfaceAtomic,IRAtomic,EmulatorAtomic atomic
119109
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
110+
111+
class Emulator highlight
112+
113+
class Interface normal
114+
class RealTime normal
115+
class IR normal
120116
121-
class Emulator highlight
122117
```
123118
The tools in this repository allow for self-hosting a server to run
124119
quantum programs on classical emulators, highlighted in the stack diagram in red.

0 commit comments

Comments
 (0)