Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nulinspiratie committed Oct 11, 2024
1 parent a11b104 commit 7969cee
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Here’s a basic example to get you started with QuAM:

```python
from quam.components import BasicQuAM, SingleChannel, pulses
from qm import qua

# Create a root-level QuAM instance
machine = BasicQuAM()
Expand All @@ -34,14 +35,14 @@ channel = SingleChannel(opx_output=("con1", 1))
machine.channels["output"] = channel

# Add a Gaussian pulse to the channel
channel.operations["gaussian"] = pulses.Gaussian(
channel.operations["gaussian"] = pulses.GaussianPulse(
length=100, # Pulse length in ns
amplitude=0.5, # Peak amplitude of Gaussian pulse
sigma=20, # Standard deviation of Guassian pulse
)

# Play the Gaussian pulse on the channel within a QUA program
with program() as prog:
with qua.program() as prog:
channel.play("gaussian")

# Generate the QUA configuration from QuAM
Expand Down
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ QuAM is not just a tool but a gateway to streamlined and efficient quantum compu

```python
from quam.components import *
from qm import qua

# Create a root-level QuAM instance
machine = BasicQuAM()
Expand All @@ -28,12 +29,12 @@ channel = SingleChannel(opx_output=("con1", 1))
machine.channels["output"] = channel

# Add a Gaussian pulse to the channel
channel.operations["gaussian"] = pulses.Gaussian(
channel.operations["gaussian"] = pulses.GaussianPulse(
length=100, amplitude=0.5, sigma=20
)

# Play the Gaussian pulse within a QUA program
with program() as prog:
with qua.program() as prog:
channel.play("gaussian")

# Generate the QUA configuration from QuAM
Expand Down

0 comments on commit 7969cee

Please sign in to comment.