Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add page on Pulses and Waveforms #793

Open
wants to merge 4 commits into
base: docs-v2
Choose a base branch
from
Open

Add page on Pulses and Waveforms #793

wants to merge 4 commits into from

Conversation

HGSilveri
Copy link
Collaborator

  • Adds the Fundamentals page on Pulses and Waveforms

@HGSilveri HGSilveri self-assigned this Jan 23, 2025
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

"source": [
"## Programming the driving Hamiltonian\n",
"\n",
"To program the [driving Hamiltonian](programming.md#driving-hamiltonian) of a system with $N$ atoms in Pulser, one needs to combine two objects:\n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps having the Driving Hamiltonian repeated here would make sense ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Idk, I feel like we are repeating it ad nauseam, I was hoping the link would be enough at this point...

docs/source/pulses.ipynb Outdated Show resolved Hide resolved
docs/source/pulses.ipynb Outdated Show resolved Hide resolved
"\n",
"<div class=\"alert alert-info\">\n",
"\n",
"In a `Pulse`, $\\Omega(t)$ and $\\delta(t)$ are always in units of $rad/\\mu s$, while $\\phi$ is in $rad$.\n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we eventually add:

Suggested change
"In a `Pulse`, $\\Omega(t)$ and $\\delta(t)$ are always in units of $rad/\\mu s$, while $\\phi$ is in $rad$.\n",
"In a `Pulse`, $\\Omega(t)$ and $\\delta(t)$ are always in units of $rad/\\mu s$, while $\\phi$ is in $rad$. This comes from the [Hamiltonian](programming.md#hamiltonian-evolve-state):\n",
- $\\phi$ is a phase in a cosine (and the unit of a phase is $rad$).
- $\\Omega(t)$ and $\\delta(t)$ are coefficients in the Hamiltonian. Their integral gives a phase in a complex exponential $\exp\left(i \int_0^{\Delta t} H(t) dt\right)$, hence their units are in $rad/\mu s$.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this is more of a detail and not particularly actionable information. If we want to give these explanations, I'd say it fit better close to the Hamiltonian, perhaps in the Conventions page?

Comment on lines +202 to +210
"source": [
".. currentmodule:: pulser.pulse\n",
"\n",
".. autosummary::\n",
"\n",
" Pulse.ConstantAmplitude\n",
" Pulse.ConstantDetuning\n",
" Pulse.ConstantPulse"
]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's weird they don't render all the same, with some having 'cls'
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's because ConstantAmplitude and ConstantDetuning have the @parametrize decorator... I don't think this is an easy fix, if it's confusing I can also just omit the signatures?

docs/source/pulses.ipynb Outdated Show resolved Hide resolved
Copy link
Collaborator Author

@HGSilveri HGSilveri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review!

"source": [
"## Programming the driving Hamiltonian\n",
"\n",
"To program the [driving Hamiltonian](programming.md#driving-hamiltonian) of a system with $N$ atoms in Pulser, one needs to combine two objects:\n",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Idk, I feel like we are repeating it ad nauseam, I was hoping the link would be enough at this point...

"\n",
"<div class=\"alert alert-info\">\n",
"\n",
"In a `Pulse`, $\\Omega(t)$ and $\\delta(t)$ are always in units of $rad/\\mu s$, while $\\phi$ is in $rad$.\n",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this is more of a detail and not particularly actionable information. If we want to give these explanations, I'd say it fit better close to the Hamiltonian, perhaps in the Conventions page?

Comment on lines +202 to +210
"source": [
".. currentmodule:: pulser.pulse\n",
"\n",
".. autosummary::\n",
"\n",
" Pulse.ConstantAmplitude\n",
" Pulse.ConstantDetuning\n",
" Pulse.ConstantPulse"
]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's because ConstantAmplitude and ConstantDetuning have the @parametrize decorator... I don't think this is an easy fix, if it's confusing I can also just omit the signatures?

@ferrulli1pasqal
Copy link
Collaborator

Nice. The only thing that we can maybe add is a link to this page from the section Programming a neutral-atom QPU in the getting strted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants