Skip to content

Commit 5c1d0f5

Browse files
weinbe58weinbe58
committed
backporting updates
2 parents 3c23344 + c6911a4 commit 5c1d0f5

32 files changed

+3709
-844
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
python-version: ["3.10", "3.11", "3.12"]
2020

2121
steps:
22-
- uses: actions/checkout@v4
22+
- uses: actions/checkout@v5
2323
- name: Install uv
2424
uses: astral-sh/setup-uv@v6
2525
with:
@@ -53,9 +53,9 @@ jobs:
5353
needs: build
5454
if: github.event.pull_request
5555
steps:
56-
- uses: actions/checkout@v4
56+
- uses: actions/checkout@v5
5757
- name: download coverage
58-
uses: actions/download-artifact@v4
58+
uses: actions/download-artifact@v5
5959
with:
6060
name: code-coverage-report
6161
- name: check coverage

‎.github/workflows/devdoc.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Deploy Devopment Branch Docs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
9+
cancel-in-progress: true
10+
11+
jobs:
12+
documentation:
13+
name: Deploy dev documentation
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v5
17+
with:
18+
fetch-depth: 0
19+
- name: Install uv
20+
uses: astral-sh/setup-uv@v6
21+
with:
22+
# Install a specific version of uv.
23+
version: "0.5.1"
24+
enable-cache: true
25+
cache-dependency-glob: "uv.lock"
26+
- name: Install Documentation dependencies
27+
run: uv sync --group doc --index="https://${{ secrets.JFROG_USER}}:${{ secrets.JFROG_TOKEN }}@quera.jfrog.io/artifactory/api/pypi/quera-pypi-algo/simple/"
28+
- name: Set up build cache
29+
uses: actions/cache@v4
30+
id: cache
31+
with:
32+
key: mkdocs-material-${{ github.ref }}
33+
path: .cache
34+
restore-keys: |
35+
mkdocs-material-
36+
# derived from:
37+
# https://github.com/RemoteCloud/public-documentation/blob/dev/.github/workflows/build_docs.yml
38+
- name: Configure Git user
39+
run: |
40+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
41+
git config --local user.name "github-actions[bot]"
42+
- name: Deploy documentation
43+
env:
44+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
45+
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
46+
run: |
47+
git fetch origin gh-pages --depth=1
48+
uv run mike deploy -p dev

‎.github/workflows/doc.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Documentation (preview)
2+
on:
3+
pull_request:
4+
types:
5+
- opened
6+
- reopened
7+
- synchronize
8+
- closed
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
documentation:
15+
name: Deploy preview documentation
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v5
19+
- name: Install uv
20+
uses: astral-sh/setup-uv@v6
21+
with:
22+
# Install a specific version of uv.
23+
version: "0.5.1"
24+
enable-cache: true
25+
cache-dependency-glob: "uv.lock"
26+
- name: Install Documentation dependencies
27+
run: uv sync --group doc --index="https://${{ secrets.JFROG_USER}}:${{ secrets.JFROG_TOKEN }}@quera.jfrog.io/artifactory/api/pypi/quera-pypi-algo/simple/"
28+
- name: Set up build cache
29+
uses: actions/cache@v4
30+
id: cache
31+
with:
32+
key: mkdocs-material-${{ github.ref }}
33+
path: .cache
34+
restore-keys: |
35+
mkdocs-material-
36+
- name: Deploy documentation
37+
env:
38+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
39+
run: |
40+
uv run mkdocs build
41+
- name: Deploy preview
42+
uses: rossjrw/pr-preview-action@v1
43+
with:
44+
source-dir: ./site

‎.github/workflows/lint.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ jobs:
1212
isort:
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: actions/checkout@v4
15+
- uses: actions/checkout@v5
1616
- uses: isort/isort-action@v1
1717
with:
1818
sortPaths: "src" # only sort files in the src directory
1919
ruff:
2020
runs-on: ubuntu-latest
2121
steps:
22-
- uses: actions/checkout@v4
22+
- uses: actions/checkout@v5
2323
- uses: chartboost/ruff-action@v1
2424
black:
2525
runs-on: ubuntu-latest
2626
steps:
27-
- uses: actions/checkout@v4
27+
- uses: actions/checkout@v5
2828
- uses: psf/black@stable
2929
pyright:
3030
runs-on: ubuntu-latest
3131
steps:
32-
- uses: actions/checkout@v4
32+
- uses: actions/checkout@v5
3333
- name: Install uv
3434
uses: astral-sh/setup-uv@v6
3535
with:

‎.github/workflows/pub_doc.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy Release Docs
2+
on:
3+
push:
4+
tags:
5+
- "v*"
6+
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
9+
cancel-in-progress: true
10+
11+
jobs:
12+
documentation:
13+
name: Deploy release documentation
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v5
17+
with:
18+
fetch-depth: 0
19+
- name: Install uv
20+
uses: astral-sh/setup-uv@v6
21+
with:
22+
# Install a specific version of uv.
23+
version: "0.5.1"
24+
enable-cache: true
25+
cache-dependency-glob: "uv.lock"
26+
- name: Install Documentation dependencies
27+
run: uv sync --group doc --index="https://${{ secrets.JFROG_USER}}:${{ secrets.JFROG_TOKEN }}@quera.jfrog.io/artifactory/api/pypi/quera-pypi-algo/simple/"
28+
- name: Set up build cache
29+
uses: actions/cache@v4
30+
id: cache
31+
with:
32+
key: mkdocs-material-${{ github.ref }}
33+
path: .cache
34+
restore-keys: |
35+
mkdocs-material-
36+
# derived from:
37+
# https://github.com/RemoteCloud/public-documentation/blob/dev/.github/workflows/build_docs.yml
38+
- name: Configure Git user
39+
run: |
40+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
41+
git config --local user.name "github-actions[bot]"
42+
- name: Set release notes tag
43+
run: |
44+
export TAG_PATH=${{ github.ref }}
45+
echo ${TAG_PATH}
46+
echo "TAG_VERSION=${TAG_PATH##*/}" >> $GITHUB_ENV
47+
echo ${TAG_VERSION}
48+
- name: Deploy documentation
49+
env:
50+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
51+
run: |
52+
git fetch origin gh-pages --depth=1
53+
uv run mike deploy --update-alias --push ${TAG_VERSION} latest

‎.github/workflows/release.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
runs-on: ubuntu-latest
99

1010
steps:
11-
- uses: actions/checkout@v4
11+
- uses: actions/checkout@v5
1212
- name: Install uv
1313
uses: astral-sh/setup-uv@v6
1414
with:
@@ -39,7 +39,7 @@ jobs:
3939

4040
steps:
4141
- name: Download all the dists
42-
uses: actions/download-artifact@v4
42+
uses: actions/download-artifact@v5
4343
with:
4444
name: python-package-distributions
4545
path: dist/
@@ -60,7 +60,7 @@ jobs:
6060

6161
steps:
6262
- name: Download all the dists
63-
uses: actions/download-artifact@v4
63+
uses: actions/download-artifact@v5
6464
with:
6565
name: python-package-distributions
6666
path: dist/

‎.pre-commit-config.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ repos:
2626
hooks:
2727
- id: pyright-check
2828
name: pyright-check
29-
entry: pyright .
29+
entry: uv run pyright .
3030
language: system
3131
pass_filenames: false
3232
always_run: true
3333
- id: pytest-check
3434
name: pytest-check
35-
entry: pytest test
35+
entry: uv run pytest test
3636
language: system
3737
pass_filenames: false
3838
always_run: true

‎README.md‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
11
# Bloqade-Shuttle
22

3-
SDK for simulation and running QuEra's neutral atom quantum computers with explicit shuttling.
3+
Bloqade-shuttle is an SDK for simulation and programming neutral atom quantum computers
4+
at the level of atom layout and shuttling.
5+
6+
The project aims to establish eDSL for programming and optimizing atom layout and
7+
shuttling operations on neutral atom quantum computers. Our goal is to provide a
8+
framework for anyone to use with neutral atom quantum technology.
9+
10+
We welcome industry and academic partners to collaborate to develop Bloqade-shuttle to
11+
further advance neutral atom technology and its applications to quantum computing.
12+
13+
If you are interested in guiding future development of this project, consider becoming a
14+
member of our open source steering committee! We also welcome contributions via pull
15+
requests, bug reports, or feature requests.
16+
17+
## Installation
18+
19+
```bash
20+
uv add bloqade-shuttle
21+
```
22+
<!--- TODO: update links to point to documentation website once available. --->
23+
See [Installation](https://queracomputing.github.io/bloqade-shuttle/dev/install) for more details.
24+
25+
Check out new [Blog](https://queracomputing.github.io/bloqade-shuttle/dev/blog/) to understand more about tools and shuttle.
26+
27+
28+
## Other useful links
29+
30+
- [Documentation](https://queracomputing.github.io/bloqade-shuttle/dev/)
31+
- [Bloqade Geometry](https://queracomputing.github.io/bloqade-geometry/dev/): a related
32+
project that provides components for defining and manipulating geometric objects in
33+
Bloqade Shuttle.
34+
35+
## Stability
36+
37+
Bloqade-Shuttle is currently in active development, while we are gathering feedback from
38+
early users and refining the language design. We can work with our partners to provide
39+
support for transitioning to the new language as well as ongoing maintenance and
40+
updates.

‎docs/blog/.authors.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
authors:
2+
kaihsin:
3+
name: Kai-Hsin Wu
4+
description: Scientific Software Engineer at QuEra Computing Inc.
5+
avatar: https://github.com/kaihsin.png
6+
url: https://github.com/kaihsin
7+
8+
pweinberg:
9+
name: Phillip Weinberg
10+
description: Senior Scientific Software Engineer at QuEra Computing Inc.
11+
avatar: https://github.com/weinbe58.png
12+
url: https://github.com/weinbe58
13+
14+
sostermann:
15+
name: Stefan Ostermann
16+
description: Algorithm's Team Lead at QuEra Computing Inc.
17+
avatar: https://github.com/stefan-o.png
18+
url: https://github.com/stefan-o

‎docs/blog/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Blog

0 commit comments

Comments
 (0)