Skip to content

Fixing docs #1007

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 7 commits into from
Feb 27, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/link-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ jobs:
uses: ruzickap/action-my-broken-link-checker@v2
with:
url: https://bloqade.quera.com
cmd_params: "--buffer-size=8192 --exclude='https://github.com/QuEraComputing/bloqade-python/edit/' --exclude='https://fonts.gstatic.com'"
cmd_params: "--buffer-size=8192 --exclude='https://github.com/QuEraComputing/bloqade-analog/edit/' --exclude='https://fonts.gstatic.com'"
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ date-released: '2024-05-04'
doi: 10.5281/zenodo.11114110
license:
- cc-by-4.0
repository-code: https://github.com/QuEraComputing/bloqade-python/tree/v0.15.11
title: 'QuEraComputing/bloqade-python: v0.15.11'
repository-code: https://github.com/QuEraComputing/bloqade-analog/tree/v0.15.11
title: 'QuEraComputing/bloqade-analog: v0.15.11'
type: software
version: v0.15.11
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The bloqade-python package is licensed under the Apache License, Version 2.0:
The bloqade-analog package is licensed under the Apache License, Version 2.0:

> Copyright (c) 2023 QuEra Computing Inc..
>
Expand Down
43 changes: 22 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark.png">
<source media="(prefers-color-scheme: light)" srcset="docs/assets/logo.png">
<source srcset="docs/assets/logo.png">
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/analog-logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="docs/assets/analog-logo.svg">
<img src="docs/assets/logo.svg" alt="Bloqade Logo">
</picture>
</div>

<div align="center">
<img src="docs/assets/logo.png" alt="Bloqade Logo">
</picture>
</div>

[![Latest Version](https://img.shields.io/pypi/v/bloqade.svg)](https://pypi.python.org/pypi/bloqade)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/bloqade.svg)](https://pypi.python.org/pypi/bloqade)
[![codecov](https://codecov.io/github/QuEraComputing/bloqade-python/graph/badge.svg?token=4YJFc45Jyl)](https://codecov.io/github/QuEraComputing/bloqade-python)
![CI](https://github.com/QuEraComputing/bloqade-python/actions/workflows/ci.yml/badge.svg)
[![Documentation](https://img.shields.io/badge/Documentation-6437FF)](https://queracomputing.github.io/bloqade-python/latest/)
[![Latest Version](https://img.shields.io/pypi/v/bloqade.svg)](https://pypi.python.org/pypi/bloqade-analog)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/bloqade.svg)](https://pypi.python.org/pypi/bloqade-analog)
[![codecov](https://codecov.io/github/QuEraComputing/bloqade-analog/graph/badge.svg?token=4YJFc45Jyl)](https://codecov.io/github/QuEraComputing/bloqade-analog)
![CI](https://github.com/QuEraComputing/bloqade-analog/actions/workflows/ci.yml/badge.svg)
[![Documentation](https://img.shields.io/badge/Documentation-6437FF)](https://queracomputing.github.io/bloqade-analog/latest/)
[![DOI](https://zenodo.org/badge/629628885.svg)](https://zenodo.org/doi/10.5281/zenodo.11114109)


> [!IMPORTANT]
>
> Bloqade has been restructured to make room for new features and improvements. Please refer to the [migration guide](https://bloqade.quera.com/dev/home/migration/) for more information.


# Welcome to Bloqade -- QuEra's Neutral Atom SDK

## What is Bloqade?
Expand Down Expand Up @@ -47,12 +48,12 @@ In order to better understand more about Bloqade users we would kindly ask that
You can install the package with `pip` in your Python environment of choice via:

```sh
pip install bloqade
pip install bloqade-analog
```

## Documentation

If you're already convinced about what Bloqade brings to the table, feel free to take a look at our documentation with examples [here](https://queracomputing.github.io/bloqade-python/latest/).
If you're already convinced about what Bloqade brings to the table, feel free to take a look at our documentation with examples [here](https://queracomputing.github.io/bloqade-analog/latest/).

If you aren't convinced, keep scrolling!

Expand Down Expand Up @@ -80,8 +81,8 @@ Let Bloqade handle keeping track of all the variations while you focus on becomi
Did we mention you can throw your program at hardware and emulation and still keep your parameter sweeps?

```python
from bloqade import var
from bloqade.atom_arrangement import Square
from bloqade.analog import var
from bloqade.analog.atom_arrangement import Square

import numpy as np

Expand Down Expand Up @@ -134,7 +135,7 @@ You can save any intermediate steps in your program construction, enabling you t
Feel free to let your waveforms grow to your liking too!:

```python
from bloqade import start
from bloqade.analog import start

# Save your intermediate steps any way you like
initial_geometry = start.add_position((0, 0))
Expand All @@ -152,8 +153,8 @@ program_2 = target_rabi_wf.piecewise_linear(
Want to focus on building one part of your program first before others (or, just want that same Bloqade.jl flavor?) We've got you covered:

```python
from bloqade import piecewise_linear, var
from bloqade.ir.location import Square
from bloqade.analog import piecewise_linear, var
from bloqade.analog.ir.location import Square
import numpy as np

# Create a geometry without worrying about pulses yet
Expand Down Expand Up @@ -204,7 +205,7 @@ program_with_few_atoms.parallelize(24).braket.aquila(24).run_async(100)

Bloqade wouldn't exist if we weren't fortunate enough to obtain feedback from awesome members of our community such as yourself (:

If you find a bug, have an idea, or find an issue with our documentation, please feel free to file an issue on the [Github repo itself](https://github.com/QuEraComputing/bloqade-python/issues/new/choose).
If you find a bug, have an idea, or find an issue with our documentation, please feel free to file an issue on the [Github repo itself](https://github.com/QuEraComputing/bloqade-analog/issues/new/choose).

After using/experimenting/tinkering/hacking with Bloqade it would also be helpful to us for you to fill out [this form](https://share.hsforms.com/1FJjYan2VQC6NfrQ5IPAcewdrwvd) which allows us to get some more detailed feedback.

Expand Down
Loading
Loading