Skip to content
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.

Sign up for GitHub

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

Builder diagram links #753

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Builder diagram links #753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e376bac
Allowing reference but ignore reference/bloqade
weinbe58 Oct 25, 2023
c0912e4
adding links to API reference in builder diagram.
weinbe58 Oct 25, 2023
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
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ docs/_build/

# mkdocs
site/
docs/reference/
docs/reference/bloqade/

# PyBuilder
.pybuilder/
Expand Down
0 docs/builder-workflow/overview.md → docs/reference/overview.md
View file
Open in desktop
File renamed without changes.
35 changes: 27 additions & 8 deletions docs/builder-workflow/standard.md → docs/reference/standard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@

# Build Workflow

``` mermaid
```mermaid

flowchart TD

ProgramStart(["start"])

Geometry("Geometry or Lattice")
Expand Down Expand Up @@ -67,9 +65,13 @@ flowchart TD
python
julia"])

Submit("Execution
------------
Execution("
Execution hardware only
-------------------------------
run_async()

Hardware and simulation
-------------------------------
run()
__call__")

Expand Down Expand Up @@ -97,7 +99,24 @@ flowchart TD
Services -->|quera| QuEraBackends;
Services -->|braket| BraketBackends;
Services -->|bloqade| BloqadeBackends;
QuEraBackends --> Submit;
BraketBackends --> Submit;
BloqadeBackends --> Submit;
QuEraBackends --> Execution;
BraketBackends --> Execution;
BloqadeBackends --> Execution;

click ProgramStart "../bloqade/#bloqade.start";
click Geometry "../bloqade/atom_arrangement/";
click Coupling "../bloqade/builder/drive/";
click Detuning "../bloqade/builder/field/#bloqade.builder.field.Detuning";
click Rabi "../bloqade/builder/field/#bloqade.builder.field.Rabi";
click Amplitude "../bloqade/builder/field/#bloqade.builder.field.Amplitude";
click Phase "../bloqade/builder/field/#bloqade.builder.field.Phase";
click SpaceModulation "../bloqade/builder/spatial/";
click Waveform "../bloqade/builder/waveform/";
click Options "../bloqade/builder/pragmas/";
click Services "../bloqade/builder/backend/";
click QuEraBackends "../bloqade/builder/backend/quera/#bloqade.builder.backend.quera.QuEraDeviceRoute";
click BraketBackends "../bloqade/builder/backend/braket/#bloqade.builder.backend.braket.BraketDeviceRoute";
click BloqadeBackends "../bloqade/builder/backend/bloqade/#bloqade.builder.backend.bloqade.BloqadeBackend";
click Execution "../bloqade/ir/routine/braket/#bloqade.ir.routine.braket.BraketRoutine";

```
4 changes: 2 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ nav:
- Home: index.md
- Tutorials: 'https://queracomputing.github.io/bloqade-python-examples/latest/'
- Reference:
- Builder Overview: builder-workflow/overview.md
- Builder Standard Diagram: builder-workflow/standard.md
- Builder Overview: reference/overview.md
- Builder Standard Diagram: reference/standard.md
- API References : reference/bloqade/
- Blog:
- 2023:
Expand Down
Loading