Skip to content

Commit

Permalink
Module-level docstring for simulator
Browse files Browse the repository at this point in the history
  • Loading branch information
rmshaffer committed May 21, 2024
1 parent e3fc7a0 commit 74b817b
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions src/autoqasm/simulator/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,26 @@
# language governing permissions and limitations under the License.

"""
TODO: Module description
This module contains a local simulator implementation which can be used to
simulate AutoQASM programs at the full OpenQASM 3.0 scope of functionality,
including programs which contain mid-circuit measurement and classical control flow.
TODO: Example usage
The recommended usage of this simulator is by instantiating the Braket LocalSimulator
object with the "autoqasm" backend:
.. code-block:: python
# Python code here
import autoqasm as aq
from braket.devices.local_simulator import LocalSimulator
@aq.main
def bell_state():
h(0)
cnot(0, 1)
return measure([0, 1])
device = LocalSimulator("autoqasm")
result = device.run(bell_state, shots=100).result()
"""

from .simulator import McmSimulator # noqa: F401

0 comments on commit 74b817b

Please sign in to comment.