-
Notifications
You must be signed in to change notification settings - Fork 66
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
base: docs-v2
Are you sure you want to change the base?
Conversation
HGSilveri
commented
Jan 23, 2025
- Adds the Fundamentals page on Pulses and Waveforms
Check out this pull request on 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", |
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we eventually add:
"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$. |
There was a problem hiding this comment.
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?
"source": [ | ||
".. currentmodule:: pulser.pulse\n", | ||
"\n", | ||
".. autosummary::\n", | ||
"\n", | ||
" Pulse.ConstantAmplitude\n", | ||
" Pulse.ConstantDetuning\n", | ||
" Pulse.ConstantPulse" | ||
] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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?
There was a problem hiding this 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", |
There was a problem hiding this comment.
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", |
There was a problem hiding this comment.
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?
"source": [ | ||
".. currentmodule:: pulser.pulse\n", | ||
"\n", | ||
".. autosummary::\n", | ||
"\n", | ||
" Pulse.ConstantAmplitude\n", | ||
" Pulse.ConstantDetuning\n", | ||
" Pulse.ConstantPulse" | ||
] |
There was a problem hiding this comment.
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?
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. |