Skip to content

Documents refactor #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from 3 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
4 changes: 4 additions & 0 deletions docs/quick_start/circuits/API/qasm2 core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
6 changes: 6 additions & 0 deletions docs/quick_start/circuits/API/qasm2 inline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.

?? Merge with qasm2 core API to cut down on pages?
4 changes: 4 additions & 0 deletions docs/quick_start/circuits/API/qasm2 noise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
4 changes: 4 additions & 0 deletions docs/quick_start/circuits/API/qasm2 parallel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
6 changes: 6 additions & 0 deletions docs/quick_start/circuits/API/qasm2 uop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.

?? Merge with qasm2 core API to cut down on pages?
4 changes: 4 additions & 0 deletions docs/quick_start/circuits/compiler_passes/asap_parallelism.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
4 changes: 4 additions & 0 deletions docs/quick_start/circuits/compiler_passes/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.

# Digital Quantum Computing

This section provides the quick start guide for programming digital quantum circuits using Bloqade.


## Open Quantum Assembly Language (QASM2)

Bloqade provides a set of dialects for QASM2 and our custom extensions to model parallel gates in neutral atom architectures. The QASM2 dialect is a simple quantum assembly language that allows you to write quantum circuits in a human-readable format. However, one should note that QASM2 is a very restricted language and does not support all the features of a high-level language.

For example, there is a separation of **gate routines** declared with `gate` and main program written as a sequence of gate applications. While the gate routine is similar to a function in many ways, it does not support high-level features such as recursions (due to lack of `if` statement support inside) or control flows.

While in our initial release, we support QASM2 as the first eDSL, we plan to use it as a compile target instead of a programming language for long-term development. We are working on a more expressive language that will be more suitable for quantum programming at error-corrected era.


!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
Expand Down Expand Up @@ -145,8 +164,4 @@ measure q[0] -> c[0];
measure q[1] -> c[1];
```

Note that the `return` values are all ignore due to lack of equivalent in QASM2.

## API Reference

::: bloqade.qasm2
Note that the `return` values are all ignore due to lack of equivalent in QASM2.
4 changes: 4 additions & 0 deletions docs/quick_start/circuits/interpreters_and_analysis/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
17 changes: 0 additions & 17 deletions docs/quick_start/digital/index.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/quick_start/qourier/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.

Hardware level moves. Included as an example "extra" dialect set. !! To be removed before open open source !!
4 changes: 4 additions & 0 deletions docs/vision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! warning
This page is under construction. The content may be incomplete or incorrect. Submit an issue
on [GitHub](https://github.com/QuEraComputing/bloqade/issues/new) if you need help or want to
contribute.
39 changes: 31 additions & 8 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,43 @@ nav:
- index.md
- Installation: install.md
- Background: background.md
- Vision: vision.md
- Quick Start:
- Digital:
- quick_start/digital/index.md
- QASM2: quick_start/digital/qasm2.md
- Circuits:
- quick_start/circuits/index.md
- Examples:
- Quantum Fourier Transform: "digital/examples/qft.py"
- GHZ state preparation: "digital/examples/ghz.py"
- Pauli Exponential: "digital/examples/pauli_exponentiation.py"
- Repeat Until Success: "digital/examples/repeat_until_success.py"
- QAOA: "digital/examples/qaoa.py"
- Compiler passes:
- quick_start/circuits/compiler_passes/index.md
- Native gate rewrite: quick_start/circuits/compiler_passes/native_gate_rewrite.md
- ASAP Parallelism: quick_start/circuits/compiler_passes/asap_parallelism.md
- Circuit simplification: quick_start/circuits/compiler_passes/circuit_simplification.md
- Interpreters and analysis:
- quick_start/circuits/interpreters_and_analysis/index.md
- QASM2 Codegen: quick_start/circuits/interpreters_and_analysis/qasm2_codegen.md
- PyQrack emulator: quick_start/circuits/interpreters_and_analysis/pyqrack_emulator.md
- Circuit dialect API:
- QASM2 Core: quick_start/circuits/API/qasm2 core.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should use an underscore instead space to make most OS happy, e.g qasm2 core => qasm2_core. Other than that I think this is good to go. We can have everyone split the doc tasks.

- QASM2 Noise: quick_start/circuits/API/qasm2 noise.md
- QASM2 Parallel: quick_start/circuits/API/qasm2 parallel.md
- QASM2 Uop: quick_start/circuits/API/qasm2 uop.md
- Analog:
- quick_start/analog/index.md
- Qourier:
- quick_start/qourier/index.md
- Contributing: contrib.md
- Digital Tutorial:
- digital/index.md
- Quantum Fourier Transform: "digital/examples/qft.py"
- GHZ state preparation: "digital/examples/ghz.py"
- Pauli Exponential: "digital/examples/pauli_exponentiation.py"
- Repeat Until Success: "digital/examples/repeat_until_success.py"
- QAOA: "digital/examples/qaoa.py"
- Circuits:
- Quantum Fourier Transform: "digital/examples/qft.py"
- GHZ state preparation: "digital/examples/ghz.py"
- Pauli Exponential: "digital/examples/pauli_exponentiation.py"
- Repeat Until Success: "digital/examples/repeat_until_success.py"
- QAOA: "digital/examples/qaoa.py"
- Analog Tutorial: 'https://queracomputing.github.io/bloqade-python/latest/'
- Blog:
- blog/index.md
Expand Down
Loading