Skip to content

Commit

Permalink
Add QutipResult, fixing typo, generate dmm class
Browse files Browse the repository at this point in the history
  • Loading branch information
a-corni committed Sep 27, 2023
1 parent b1a3a9a commit 26ba69d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/source/apidoc/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The register classes allow for the creation of arbitrary registers.
Register layout
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A ``RegisterLayout`` is used to define a register from a set of traps. It is
intended to be given to the user by the hardware provided as a way of showing
intended to be given to the user by the hardware provider as a way of showing
which layouts are already available on a given device. In turn, the user
can create a ``Register`` by selecting the traps on which to place atoms, or
even a ``MappableRegister``, which allows for the creation of sequences whose
Expand Down Expand Up @@ -126,7 +126,7 @@ Available Channels
:members:
:show-inheritance:

.. automodule:: pulser.channels.dmm
.. autoclass:: pulser.channels.dmm.DMM
:members:
:show-inheritance:

Expand Down
13 changes: 10 additions & 3 deletions docs/source/apidoc/simulation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,20 @@ Simulation Results

Depending on the types of noise involved in a simulation, the results are returned
as an instance of :class:`SimulationResults`, namely :class:`CoherentResults`
(when the results can still be represented as a state vector or a density matrix, before being measured)
or :class:`NoisyResults` (when they can only be represented as a probability
distribution over the basis states).
(when each result can still be represented as a :class:`QutipResult` i.e. a state vector
or a density matrix, before being measured) or :class:`NoisyResults` (when each of them can only
be represented as :class:`SampledResult` i.e. a probability distribution over the basis states).

Both classes feature methods for processing and displaying the results stored
within them.

QutipResult
^^^^^^^^^^^^^^^^

.. autoclass:: pulser_simulation.qutip_result.QutipResult
:members:
:show-inheritance:

CoherentResults
^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 26ba69d

Please sign in to comment.