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

Make drive non user-facing #4021

Merged
merged 10 commits into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions doc/releases/changelog-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,15 @@
the Hamiltonian of the interaction of all the Rydberg atoms.
* A new user-facing `transmon_interaction` function is added, constructing
the Hamiltonian that describes the circuit QED interaction Hamiltonian of superconducting transmon systems.
* A new user-facing `drive` function is added, which returns a `ParametrizedHamiltonian` (`HardwareHamiltonian`) containing
the Hamiltonian of the interaction between a driving electro-magnetic field and a group of qubits.
* A new user-facing `rydberg_drive` function is added, which returns a `ParametrizedHamiltonian` (`HardwareHamiltonian`) containing
the Hamiltonian of the interaction between a driving laser field and a group of Rydberg atoms.
* A new user-facing `rydberg_drive` function is added, which returns a `ParametrizedHamiltonian` (`HardwareHamiltonian`) containing the Hamiltonian of the interaction between a driving laser field and a group of Rydberg atoms.
[(#3749)](https://github.com/PennyLaneAI/pennylane/pull/3749)
[(#3911)](https://github.com/PennyLaneAI/pennylane/pull/3911)
[(#3930)](https://github.com/PennyLaneAI/pennylane/pull/3930)
[(#3936)](https://github.com/PennyLaneAI/pennylane/pull/3936/)
[(#3936)](https://github.com/PennyLaneAI/pennylane/pull/3936)
[(#3966)](https://github.com/PennyLaneAI/pennylane/pull/3966)
[(#3987)](https://github.com/PennyLaneAI/pennylane/pull/3987)
[(#4021)](https://github.com/PennyLaneAI/pennylane/pull/4021)

* A new keyword argument called `max_distance` has been added to `qml.pulse.rydberg_interaction` to allow for the removal of negligible contributions
from atoms beyond `max_distance` from each other.
[(#3889)](https://github.com/PennyLaneAI/pennylane/pull/3889)
Expand Down
1 change: 0 additions & 1 deletion pennylane/pulse/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@
~rydberg_drive
~transmon_interaction
~transmon_drive
~drive


Creating a parametrized Hamiltonian
Expand Down
4 changes: 2 additions & 2 deletions pennylane/pulse/transmon.py
Original file line number Diff line number Diff line change
Expand Up @@ -249,11 +249,11 @@ def transmon_drive(amplitude, phase, freq, wires, d=2):

.. note:: Currently only supports ``d=2`` with qudit support planned in the future. For ``d=2`` we have :math:`a:=\frac{1}{2}(\sigma^x + i \sigma^y)`.

.. note:: Due to convention in the respective fields, we ommit the factor :math:`\frac{1}{2}` present in the related constructors :func:`~.drive` and :func:`~.rydberg_drive`
.. note:: Due to convention in the respective fields, we ommit the factor :math:`\frac{1}{2}` present in the related constructor :func:`~.rydberg_drive`
mudit2812 marked this conversation as resolved.
Show resolved Hide resolved

.. seealso::

:func:`~.drive`, :func:`~.rydberg_drive`, :func:`~.transmon_interaction`
:func:`~.rydberg_drive`, :func:`~.transmon_interaction`

Args:
amplitude (Union[float, callable]): The amplitude :math:`\Omega(t)` (in GHz).
Expand Down