Skip to content

Commit 2db5571

Browse files
benjimaclellanbenjimaclellan
authored
Merge pull request #5 from OpenQuantumDesign/docs
Update documentation styles and submodules
2 parents c4a4775 + 80d5447 commit 2db5571

19 files changed

Lines changed: 218 additions & 69 deletions

‎.gitmodules‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,9 @@
1010
[submodule "oqd-compiler-infrastructure"]
1111
path = oqd-compiler-infrastructure
1212
url = https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure
13+
[submodule "oqd-trical"]
14+
path = oqd-trical
15+
url = https://github.com/OpenQuantumDesign/oqd-trical
16+
[submodule "oqd-dataschema"]
17+
path = oqd-dataschema
18+
url = https://github.com/OpenQuantumDesign/oqd-dataschema

‎README.md‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -117,19 +117,26 @@ block-beta
117117
RTGateware --> RTHardware
118118
RTHardware --> RTApparatus
119119
120-
classDef title fill:#d6d4d4,stroke:#333,color:#333;
121-
classDef digital fill:#E7E08B,stroke:#333,color:#333;
122-
classDef analog fill:#E4E9B2,stroke:#333,color:#333;
123-
classDef atomic fill:#D2E4C4,stroke:#333,color:#333;
124-
classDef realtime fill:#B5CBB7,stroke:#333,color:#333;
125-
126-
classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
127-
128-
class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
129-
class InterfaceDigital,IRDigital,EmulatorDigital digital
130-
class InterfaceAnalog,IRAnalog,EmulatorAnalog analog
131-
class InterfaceAtomic,IRAtomic,EmulatorAtomic atomic
132-
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
120+
classDef title fill:#23627D,stroke:#141414,color:#FFFFFF;
121+
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
122+
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
123+
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
124+
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;
125+
126+
classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
127+
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;
128+
129+
class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
130+
class InterfaceDigital,IRDigital,EmulatorDigital digital
131+
class InterfaceAnalog,IRAnalog,EmulatorAnalog analog
132+
class InterfaceAtomic,IRAtomic,EmulatorAtomic atomic
133+
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
134+
135+
136+
class Emulator normal
137+
class IR normal
138+
class RealTime normal
139+
class Interface normal
133140
```
134141

135142
### Software <a name="software"></a>

‎docs/hardware/devices.md‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1-
# ![Open Quantum Design](../img/oqd-logo-text.png)
1+
#
2+
3+
<p align="center">
4+
<img src="../img/oqd-logo-black.png#only-light" alt="Logo" style="max-height: 200px;">
5+
<img src="../img/oqd-logo-white.png#only-dark" alt="Logo" style="max-height: 200px;">
6+
</p>
27

38
<div align="center">
49
<h2 align="center">
510
Open Quantum Design: Quantum Processor Hardware
611
</h2>
712
</div>
813

9-
<!-- prettier-ignore -->
10-
/// admonition | Note
11-
type: note
12-
Welcome to the Open Quantum Design.
13-
This documentation is still under development, we welcome contributions! © Open Quantum Design
14-
///
15-
1614

1715
## What's Here
1816
The heart of Open Quantum Design's mission and vision is to build open-source, full-stack
@@ -72,7 +70,7 @@ block-beta
7270
space
7371
RTHardware["Lasers, Modulators, Photodetection, Ion Trap"]
7472
space
75-
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yt<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
73+
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yb<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
7674
space
7775
end
7876
space
@@ -94,13 +92,14 @@ block-beta
9492
RTGateware --> RTHardware
9593
RTHardware --> RTApparatus
9694
97-
classDef title fill:#d6d4d4,stroke:#333,color:#333;
98-
classDef digital fill:#E7E08B,stroke:#333,color:#333;
99-
classDef analog fill:#E4E9B2,stroke:#333,color:#333;
100-
classDef atomic fill:#D2E4C4,stroke:#333,color:#333;
101-
classDef realtime fill:#B5CBB7,stroke:#333,color:#333;
95+
classDef title fill:#23627D,stroke:#141414,color:#FFFFFF;
96+
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
97+
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
98+
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
99+
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;
102100
103-
classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
101+
classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
102+
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;
104103
105104
class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
106105
class InterfaceDigital,IRDigital,EmulatorDigital digital
@@ -109,6 +108,9 @@ block-beta
109108
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
110109
111110
class RealTime highlight
111+
class Emulator normal
112+
class IR normal
113+
class Interface normal
112114
```
113115

114116

‎docs/hardware/modules.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# OQD Hardware Modules
2+
3+
<div style="display: flex; flex-direction: column; width: 90%; max-width: 600px; margin: 20px auto; gap: 20px;">
4+
<iframe src="https://my.spline.design/untitled-6VCzHeqoH1f5f9FOInvPyk5l/" frameborder="0" style="width: 100%; height: 300px; border-radius: 10px;"></iframe>
5+
</div>
6+

‎docs/img/oqd-icon.png‎

89.2 KB
Loading

‎docs/img/oqd-logo-black.png‎

65.9 KB
Loading

‎docs/img/oqd-logo-text.png‎

-14.4 KB
Binary file not shown.

‎docs/img/oqd-logo-white.png‎

61.9 KB
Loading

‎docs/img/oqd-logo.png‎

-7.64 KB
Binary file not shown.

‎docs/index.md‎

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
1-
# ![Open Quantum Design](./img/oqd-logo-text.png)
1+
#
2+
3+
<p align="center">
4+
<img src="img/oqd-logo-black.png#only-light" alt="Logo" style="max-height: 200px;">
5+
<img src="img/oqd-logo-white.png#only-dark" alt="Logo" style="max-height: 200px;">
6+
</p>
27

38
<div align="center">
49
<h2 align="center">
5-
Program the world's first open-source, full-stack quantum computer.
10+
Open Quantum Design: Documentation
611
</h2>
712
</div>
813

9-
![Python](https://img.shields.io/badge/Python-3.10_|_3.11_|_3.12-blue)
10-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
11-
12-
<!-- prettier-ignore -->
13-
/// admonition | Note
14-
type: note
15-
Welcome to the Open Quantum Design framework for programming quantum computers.
16-
This documentation is still under development, please feel to contribute! © Open Quantum Design
17-
///
18-
19-
## What's here
14+
Welcome to the Open Quantum Design (OQD) documentation!
2015
Open Quantum Design is a non-profit foundation supporting the development of full-stack, open-source quantum computers.
2116
OQD's current designs are based on laser-cooled trapped ion quantum computing hardware, including real-time control, backend and frontend software.
2217
This documentation covers the software components of the OQD stack, including the core programming interfaces,
@@ -73,7 +68,7 @@ block-beta
7368
space
7469
RTHardware["Lasers, Modulators, Photodetection, Ion Trap"]
7570
space
76-
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yt<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
71+
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yb<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
7772
space
7873
end
7974
space
@@ -95,21 +90,29 @@ block-beta
9590
RTGateware --> RTHardware
9691
RTHardware --> RTApparatus
9792
98-
classDef title fill:#d6d4d4,stroke:#333,color:#333;
99-
classDef digital fill:#E7E08B,stroke:#333,color:#333;
100-
classDef analog fill:#E4E9B2,stroke:#333,color:#333;
101-
classDef atomic fill:#D2E4C4,stroke:#333,color:#333;
102-
classDef realtime fill:#B5CBB7,stroke:#333,color:#333;
93+
classDef title fill:#23627D,stroke:#141414,color:#FFFFFF;
94+
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
95+
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
96+
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
97+
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;
10398
104-
classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
99+
classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
100+
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;
105101
106-
class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
107-
class InterfaceDigital,IRDigital,EmulatorDigital digital
108-
class InterfaceAnalog,IRAnalog,EmulatorAnalog analog
109-
class InterfaceAtomic,IRAtomic,EmulatorAtomic atomic
110-
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
102+
class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
103+
class InterfaceDigital,IRDigital,EmulatorDigital digital
104+
class InterfaceAnalog,IRAnalog,EmulatorAnalog analog
105+
class InterfaceAtomic,IRAtomic,EmulatorAtomic atomic
106+
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime
107+
108+
109+
class Emulator normal
110+
class IR normal
111+
class RealTime normal
112+
class Interface normal
111113
```
112114

115+
113116
## Getting Started <a name="Getting Started"></a>
114117
Here's a short example of how to use the analog interface to specify, serialize, and simulate an analog quantum program.
115118
We use a simple, single-qubit Rabi-flopping experiment as an example:

0 commit comments

Comments
 (0)