Amazon Braket Default Simulator
The Amazon Braket Default Simulator is a Python open source library that provides an implementation of a quantum simulator that you can run locally. You can use the simulator to test quantum tasks that you construct for the Amazon Braket SDK before you submit them to the Amazon Braket service for execution.
Setting up Amazon Braket Default Simulator Python
You must have the Amazon Braket SDK installed to use the local simulator. Follow the instructions in the README for setup.
Checking the version of the default simulator
You can check your currently installed version of amazon-braket-default-simulator with pip show:
pip show amazon-braket-default-simulator
or alternatively from within Python:
>>> from braket import default_simulator
>>> default_simulator.__version__
Usage
The quantum simulator implementations StateVectorSimulator and DensityMatrixSimulator plug into the LocalSimulator interface in
Amazon Braket SDK, with the backend parameters as "braket_sv" and "braket_dm", respectively.
Alternatively, to use StateVectorSimulator, you can instantiate LocalSimulator with no arguments or with backend="default":
Executing a circuit using the default simulator
from braket.circuits import Circuit
from braket.devices import LocalSimulator
device = LocalSimulator()
bell = Circuit().h(0).cnot(0, 1)
print(device.run(bell, shots=100).result().measurement_counts)
Documentation
Detailed documentation, including the API reference, can be found on Read the Docs
To generate the API Reference HTML in your local environment
First, install tox:
pip install tox
To generate the HTML, first change directories (cd) to position the cursor in the amazon-braket-default-simulator-python directory. Then, run the following command to generate the HTML documentation files:
tox -e docs
To view the generated documentation, open the following file in a browser:
../amazon-braket-default-simulator-python/build/documentation/html/index.html
Testing
If you want to contribute to the project, be sure to run unit tests and get a successful result before you submit a pull request. To run the unit tests, first install the test dependencies using the following command:
pip install -e "amazon-braket-default-simulator-python[test]"
To run the unit tests:
tox -e unit-tests
You can also pass in various pytest arguments to run selected tests:
tox -e unit-tests -- your-arguments
For more information, please see pytest usage.
To run linters and doc generators and unit tests:
tox
To run the performance tests:
tox -e performance-tests
These tests will compare the performance of a series of simulator executions for your changes against the latest commit on the main branch. Note: The execution times for the performance tests are affected by the other processes running on the system. In order to get stable results, stop other applications when running these tests.
License
This project is licensed under the Apache-2.0 License.
1 maintainer
Metadata
1 maintainer
Release files for amazon-braket-default-simulator 1.40.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| amazon_braket_default_simulator-1.40.2.tar.gz | 205.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| amazon_braket_default_simulator-1.40.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 452.9 kB
Release files / amazon_braket_default_simulator-1.40.2.tar.gz
| Download URL | amazon_braket_default_simulator-1.40.2.tar.gz |
|---|---|
| Size | 205.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bd81e56125db94f0c1a02f3d706abe2966e80c74ad942e1ff27a12612b2b29d3
|
|
BLAKE2b-256 checksum How to use checksums |
f347a9d7456ae876a974dceaa9863c9dfe757e278016eb5afa481e92cd45cfa9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.
Transparency logRelease files / amazon_braket_default_simulator-1.40.2-py3-none-any.whl
| Download URL | amazon_braket_default_simulator-1.40.2-py3-none-any.whl |
|---|---|
| Size | 247.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d85c7c6bb40c135599e26a61ecede0361884cc1ed074d8bc902342d016de2794
|
|
BLAKE2b-256 checksum How to use checksums |
c67f54b978c5d105bbb917eb1efde37ac96db48359ac187b2b1082ab5575776f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.
Transparency log
