Metadata-Version: 2.1
Name: amazon-braket-default-simulator
Version: 1.1.1.post0
Summary: An open source quantum circuit simulator to be run locally with the Amazon Braket SDK
Home-page: https://github.com/aws/amazon-braket-default-simulator-python
Author: Amazon Web Services
License: Apache License 2.0
Description: # Amazon Braket Default Simulator
        
        [![Latest Version](https://img.shields.io/pypi/v/amazon-braket-default-simulator.svg)](https://pypi.python.org/pypi/amazon-braket-default-simulator)
        [![Supported Python Versions](https://img.shields.io/pypi/pyversions/amazon-braket-default-simulator.svg)](https://pypi.python.org/pypi/amazon-braket-default-simulator)
        [![Build Status](https://img.shields.io/github/workflow/status/aws/amazon-braket-default-simulator-python/Python%20package/main?logo=github)](https://github.com/aws/amazon-braket-default-simulator-python/actions?query=workflow%3A%22Python+package%22)
        [![codecov](https://codecov.io/gh/aws/amazon-braket-default-simulator-python/branch/main/graph/badge.svg?token=FZEG1AQU3S)](https://codecov.io/gh/aws/amazon-braket-default-simulator-python)
        [![Documentation Status](https://img.shields.io/readthedocs/amazon-braket-default-simulator-python.svg?logo=read-the-docs)](https://amazon-braket-default-simulator-python.readthedocs.io/en/latest/?badge=latest)
        [![Code Style: Black](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/psf/black)
        
        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](https://github.com/aws/amazon-braket-sdk-python)
        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](https://github.com/aws/amazon-braket-sdk-python) installed to use the local simulator.
        Follow the instructions in the [README](https://github.com/aws/amazon-braket-sdk-python/blob/main/README.md) for setup.
        
        **Checking the version of the DefaultSimulator**
        
        You can check your currently installed version of `amazon-braket-default-simulator` with `pip show`:
        
        ```bash
        pip show amazon-braket-default-simulator
        ```
        
        or alternatively from within Python:
        
        ```
        >>> from braket import default_simulator
        >>> default_simulator.__version__
        ```
        
        ## Usage
        The quantum simulator implementation `DefaultSimulator` plugs into the `LocalSimulator` interface in 
        [Amazon Braket SDK](https://github.com/aws/amazon-braket-sdk-python) using the `backend` value as `"default"`. 
        
        **Executing a circuit using the DefaultSimulator**
        ```python
        from braket.circuits import Circuit
        from braket.devices import LocalSimulator
        
        device = LocalSimulator("default")
        
        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](https://amazon-braket-default-simulator-python.readthedocs.io/en/latest/)
        
        **To generate the API Reference HTML in your local environment**
        
        First, install tox:
        
        ```bash
        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:
        
        ```bash
        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:
        
        ```bash
        pip install -e "amazon-braket-default-simulator-python[test]"
        ```
        
        To run the unit tests:
        
        ```bash
        tox -e unit-tests
        ```
        
        You can also pass in various pytest arguments to run selected tests:
        
        ```bash
        tox -e unit-tests -- your-arguments
        ```
        
        For more information, please see [pytest usage](https://docs.pytest.org/en/stable/usage.html).
        
        To run linters and doc generators and unit tests:
        
        ```bash
        tox
        ```
        
        To run the performance tests:
        
        ```bash
        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.
        
        
Keywords: Amazon AWS Quantum
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >= 3.7
Description-Content-Type: text/markdown
Provides-Extra: test
