Installation
Bloqade is available in PyPI and
thus can be installed via pip.
Install Bloqade using the following command:
pip install bloqade
Bloqade support python 3.10+.
We strongly recommend developing your compiler project using uv,
which is the official development environment for Bloqade. You can install uv using the following command:
curl -LsSf https://astral.sh/uv/install.sh | sh
then
uv add kirin-toolchain
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
then
uv add kirin-toolchain
Bloqade and its friends
Bloqade is a Python namespace package, we officially provide several sub-packages, each of which is an eDSL for neutral atom quantum computing. The following is a list of the sub-packages in Bloqade:
Note
If you have already installed Bloqade via the instructions above, all the following subpckages are already installed with the exception of the stim eDSL which is currently experimental.
bloqade.qasm2
QASM2 and its extensions support for neutral atom quantum computing. Available via:
pip install bloqade[qasm2]
bloqade.analog
Analog quantum computing eDSL for neutral atom quantum computing (previously bloqade-python). Available via:
pip install bloqade-analog
bloqade.qbraid
Support of the qBraid cloud service as a runtime backend for retrieving noise models and running circuits.
pip install bloqade[qbraid]
bloqade.stim (Experimental)
Stim and its extensions support for neutral atom quantum computing. Available via:
pip install bloqade[stim]
Development
If you want to contribute to Bloqade, you can clone the repository from GitHub:
git clone https://github.com/QuEraComputing/bloqade.git
We use uv to manage the development environment, after you install uv, you can install the development dependencies using the following command:
uv sync
Our code review requires that you pass the tests and the linting checks. We recommend
you to install pre-commit to run the checks before you commit your changes, the command line
tool pre-commit has been installed as part of the development dependencies. You can setup
pre-commit using the following command:
pre-commit install