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 DMM, methods of RegisterLayout inherited from Traps, Result #587

Merged
merged 8 commits into from
Sep 27, 2023
Merged
Changes from 5 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
20 changes: 20 additions & 0 deletions docs/source/apidoc/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ register can be defined at build time.

HGSilveri marked this conversation as resolved.
Show resolved Hide resolved
.. autoclass:: pulser.register.register_layout.RegisterLayout
:members:
:inherited-members:

.. autoclass:: pulser.register.mappable_reg.MappableRegister
:members:
Expand All @@ -51,6 +52,17 @@ Special cases
:members:
:show-inheritance:

DetuningMap
-------------------

A ``DetuningMap`` is associated to a ``DMM`` in a ``Sequence``. It links a set
of weights to a set of trap coordinates. It is intended to be defined by the user
from a ``RegisterLayout``, a ``Register`` or a ``MappableRegister`` using
``define_detuning_map``.

.. autoclass:: pulser.register.weight_maps.DetuningMap
:members:
:inherited-members:

Pulse
-------------------
Expand Down Expand Up @@ -114,6 +126,9 @@ Available Channels
:members:
:show-inheritance:

.. automodule:: pulser.channels.dmm
HGSilveri marked this conversation as resolved.
Show resolved Hide resolved
:members:
:show-inheritance:

EOM Mode Configuration
^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -129,3 +144,8 @@ Sampler
.. automodule:: pulser.sampler.samples
:members:

Result
------------------
.. automodule:: pulser.result
:members:
:show-inheritance:
HGSilveri marked this conversation as resolved.
Show resolved Hide resolved