Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,9 @@
[submodule "oqd-compiler-infrastructure"]
path = oqd-compiler-infrastructure
url = https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure
[submodule "oqd-trical"]
path = oqd-trical
url = https://github.com/OpenQuantumDesign/oqd-trical
[submodule "oqd-dataschema"]
path = oqd-dataschema
url = https://github.com/OpenQuantumDesign/oqd-dataschema
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,19 +117,26 @@ block-beta
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
classDef title fill:#23627D,stroke:#141414,color:#FFFFFF;
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;

classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;

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


class Emulator normal
class IR normal
class RealTime normal
class Interface normal
```

### Software <a name="software"></a>
Expand Down
32 changes: 17 additions & 15 deletions docs/hardware/devices.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# ![Open Quantum Design](../img/oqd-logo-text.png)
#

<p align="center">
<img src="../img/oqd-logo-black.png#only-light" alt="Logo" style="max-height: 200px;">
<img src="../img/oqd-logo-white.png#only-dark" alt="Logo" style="max-height: 200px;">
</p>

<div align="center">
<h2 align="center">
Open Quantum Design: Quantum Processor Hardware
</h2>
</div>

<!-- prettier-ignore -->
/// admonition | Note
type: note
Welcome to the Open Quantum Design.
This documentation is still under development, we welcome contributions! © Open Quantum Design
///


## What's Here
The heart of Open Quantum Design's mission and vision is to build open-source, full-stack
Expand Down Expand Up @@ -72,7 +70,7 @@ block-beta
space
RTHardware["Lasers, Modulators, Photodetection, Ion Trap"]
space
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yt<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yb<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
space
end
space
Expand All @@ -94,13 +92,14 @@ block-beta
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 title fill:#23627D,stroke:#141414,color:#FFFFFF;
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;

classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;

class InterfaceTitle,IRTitle,EmulatorsTitle,RealTimeTitle title
class InterfaceDigital,IRDigital,EmulatorDigital digital
Expand All @@ -109,6 +108,9 @@ block-beta
class RTSoftware,RTGateware,RTHardware,RTApparatus realtime

class RealTime highlight
class Emulator normal
class IR normal
class Interface normal
```


Expand Down
6 changes: 6 additions & 0 deletions docs/hardware/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# OQD Hardware Modules

<div style="display: flex; flex-direction: column; width: 90%; max-width: 600px; margin: 20px auto; gap: 20px;">
<iframe src="https://my.spline.design/untitled-6VCzHeqoH1f5f9FOInvPyk5l/" frameborder="0" style="width: 100%; height: 300px; border-radius: 10px;"></iframe>
</div>

Binary file added docs/img/oqd-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/oqd-logo-black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/oqd-logo-text.png
Binary file not shown.
Binary file added docs/img/oqd-logo-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/oqd-logo.png
Binary file not shown.
53 changes: 28 additions & 25 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
# ![Open Quantum Design](./img/oqd-logo-text.png)
#

<p align="center">
<img src="img/oqd-logo-black.png#only-light" alt="Logo" style="max-height: 200px;">
<img src="img/oqd-logo-white.png#only-dark" alt="Logo" style="max-height: 200px;">
</p>

<div align="center">
<h2 align="center">
Program the world's first open-source, full-stack quantum computer.
Open Quantum Design: Documentation
</h2>
</div>

![Python](https://img.shields.io/badge/Python-3.10_|_3.11_|_3.12-blue)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

<!-- prettier-ignore -->
/// admonition | Note
type: note
Welcome to the Open Quantum Design framework for programming quantum computers.
This documentation is still under development, please feel to contribute! © Open Quantum Design
///

## What's here
Welcome to the Open Quantum Design (OQD) documentation!
Open Quantum Design 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,
Expand Down Expand Up @@ -73,7 +68,7 @@ block-beta
space
RTHardware["Lasers, Modulators, Photodetection, Ion Trap"]
space
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yt<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
RTApparatus["Trapped-Ion QPU (<sup>171</sup>Yb<sup>+</sup>, <sup>133</sup>Ba<sup>+</sup>)"]
space
end
space
Expand All @@ -95,21 +90,29 @@ block-beta
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 title fill:#23627D,stroke:#141414,color:#FFFFFF;
classDef digital fill:#c3e1ee,stroke:#141414,color:#141414;
classDef analog fill:#afd7e9,stroke:#141414,color:#141414;
classDef atomic fill:#9ccee3,stroke:#141414,color:#141414;
classDef realtime fill:#88c4dd,stroke:#141414,color:#141414;

classDef highlight fill:#f2bbbb,stroke:#333,color:#333,stroke-dasharray: 5 5;
classDef highlight fill:#F19D19,stroke:#141414,color:#141414,stroke-dasharray: 5 5;
classDef normal fill:#fcebcf,stroke:#141414,color:#141414;

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
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


class Emulator normal
class IR normal
class RealTime normal
class Interface normal
```


## Getting Started <a name="Getting Started"></a>
Here's a short example of how to use the analog interface to specify, serialize, and simulate an analog quantum program.
We use a simple, single-qubit Rabi-flopping experiment as an example:
Expand Down
116 changes: 116 additions & 0 deletions docs/stylesheets/brand.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/* Load custom fonts from Google Fonts */
@import url('https://fonts.googleapis.com/css2?family=Raleway:wght@600;700&family=Source+Serif+Pro&display=swap');

/* Base typography */
body, .md-typeset {
font-family: 'Source Serif Pro', serif;
}

/* Headings */
h1, h2, h3, h4, h5, h6,
.md-typeset h1, .md-typeset h2, .md-typeset h3,
.md-typeset h4, .md-typeset h5, .md-typeset h6 {
font-family: 'Raleway', sans-serif;
font-weight: 700; /* Bold for headings */
}

/* Subheadings */
.md-typeset h2, .md-typeset h3 {
font-weight: 600; /* SemiBold for subheadings */
}

/* Light mode overrides */
[data-md-color-scheme="default"] {
--md-default-bg-color: #FFFFFF;
--md-primary-fg-color: #23627D; /* blue accent */
--md-accent-fg-color: #23627D;
}

/* Dark mode overrides */
[data-md-color-scheme="slate"] {
--md-default-bg-color: #141414;
--md-primary-fg-color: #23627D;
--md-accent-fg-color: #23627D;
}



/* Apply Raleway to all navigation and sidebar elements */
.md-nav,
.md-nav__title,
.md-nav__link,
.md-header,
.md-tabs,
.md-sidebar,
.md-sidebar__inner,
.md-nav__item,
.md-footer,
.md-footer__inner {
font-family: 'Raleway', sans-serif;
font-weight: 600; /* SemiBold for ToC/nav for clarity */
}




/* Page heading accent color for light mode */
[data-md-color-scheme="default"] .md-typeset h1,
[data-md-color-scheme="default"] .md-typeset h2,
[data-md-color-scheme="default"] .md-typeset h3,
[data-md-color-scheme="default"] .md-typeset h4,
[data-md-color-scheme="default"] .md-typeset h5,
[data-md-color-scheme="default"] .md-typeset h6 {
color: #7B2328; /* Warm yellow/orange for light mode */
}

/* Page heading accent color for dark mode */
[data-md-color-scheme="slate"] .md-typeset h1,
[data-md-color-scheme="slate"] .md-typeset h2,
[data-md-color-scheme="slate"] .md-typeset h3,
[data-md-color-scheme="slate"] .md-typeset h4,
[data-md-color-scheme="slate"] .md-typeset h5,
[data-md-color-scheme="slate"] .md-typeset h6 {
/* color: #F19D19; Deep red for dark mode */
color: #E45B68; /* Deep red for dark mode */
}





/* Light mode nav/ToC font color */
[data-md-color-scheme="default"] .md-nav,
[data-md-color-scheme="default"] .md-nav__link,
[data-md-color-scheme="default"] .md-header,
[data-md-color-scheme="default"] .md-tabs {
/*color: #222; /* Dark gray or your preferred shade */
color: #141414;
}

/* Dark mode nav/ToC font color */
[data-md-color-scheme="slate"] .md-nav,
[data-md-color-scheme="slate"] .md-nav__link,
[data-md-color-scheme="slate"] .md-header,
[data-md-color-scheme="slate"] .md-tabs {
color: #f0f0f0; /* Light gray or white */
}



/* Top navigation bar text and icons should be light-colored */
.md-header,
.md-header .md-header__title,
.md-header .md-header__button,
.md-header .md-tabs,
.md-header .md-tabs__link,
.md-header .md-header__topic,
.md-header .md-header__option {
color: #f0f0f0 !important; /* Light gray or white text */
fill: #f0f0f0 !important; /* Icons (SVG) */
}

/* Hover state for links in header */
.md-header .md-tabs__link:hover {
color: #ffffff !important;
text-decoration: underline;
}
29 changes: 18 additions & 11 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ site_description: Open Quantum Design - the world's first open-source quantum co
repo_name: OpenQuantumDesign/equilux
repo_url: https://github.com/OpenQuantumDesign/equilux.git

copyright: Copyright &copy; 2024 Open Quantum Design
copyright: Copyright &copy; 2024-2025 Open Quantum Design

use_directory_urls: false

Expand Down Expand Up @@ -41,37 +41,41 @@ nav:

- Core: "!include ./oqd-core/mkdocs.yaml"
- Emulators:
- Analog Emulators: "!include ./oqd-analog-emulator/mkdocs.yaml"
# - Atomic Emulators: '!include ./oqd-analog-emulator/mkdocs.yaml'
- Analog Emulator: "!include ./oqd-analog-emulator/mkdocs.yaml"
- Trapped Ion Calculator: '!include ./oqd-trical/mkdocs.yaml'
- Cloud: "!include ./oqd-cloud/mkdocs.yaml"
- Compiler Infrastructure: "!include ./oqd-compiler-infrastructure/mkdocs.yaml"
- Hardware:
- Open Hardware Devices: hardware/devices.md
- OQD Processors: hardware/devices.md
- OQD Modules: hardware/modules.md
- About OQD Hardware: hardware/about-oqd.md
- Utilities:
- Data schemas: "!include ./oqd-dataschema/mkdocs.yaml"
- About: about.md

theme:
name: material

logo: img/oqd-logo.png
favicon: img/oqd-logo.png
logo: img/oqd-icon.png
favicon: img/oqd-icon.png

palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: pink
primary: custom
accent: custom
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: pink
primary: custom
accent: custom
toggle:
icon: material/weather-night
name: Switch to light mode



features:
- search.suggest
- search.highlight
Expand All @@ -98,6 +102,8 @@ plugins:
- ./oqd-core/src
- ./oqd-analog-emulator/src
- ./oqd-cloud/src
- ./oqd-trical/src
- ./oqd-dataschema/src
options:
show_source: true
show_root_heading: true
Expand Down Expand Up @@ -164,3 +170,4 @@ extra_javascript:
extra_css:
- stylesheets/headers.css
- stylesheets/admonitions.css
- stylesheets/brand.css
Loading