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.

Sign up for GitHub

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

Modify API Reference on Classical Simulation #556

Merged
merged 7 commits into from
Jul 13, 2023
Merged

Modify API Reference on Classical Simulation #556

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
63d7a3a
Modify API
a-corni Jul 11, 2023
03031a4
Delete Simulation from doc
a-corni Jul 11, 2023
9cf23ef
Add Simulation to docs
a-corni Jul 11, 2023
07fb3c4
Modify module description, deprecation note
a-corni Jul 11, 2023
4fa3bbd
Merge branch 'develop' of https://github.com/pasqal-io/Pulser into do…
a-corni Jul 11, 2023
a12191f
Taking into account review comments
a-corni Jul 13, 2023
b950839
Merge branch 'develop' of https://github.com/pasqal-io/Pulser into do…
a-corni Jul 13, 2023
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
6 changes: 3 additions & 3 deletions docs/source/apidoc/simulation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ QutipEmulator

:class:`QutipEmulator` is the class to simulate :class:`SequenceSamples`, that are samples of a :class:`Sequence`.
It is possible to simulate directly a :class:`Sequence` object by using the class method
`SequenceSamples.from_sequence`. Since version 0.14.0, the :class:`Simulation` class is deprecated
for :class:`QutipEmulator`.
``SequenceSamples.from_sequence``. Since version 0.14.0, the :class:`Simulation` class is deprecated
a-corni marked this conversation as resolved.
Show resolved Hide resolved
in favour of :class:`QutipEmulator`.

.. automodule:: pulser_simulation.simulation
.. autoclass:: pulser_simulation.simulation.QutipEmulator
HGSilveri marked this conversation as resolved.
Show resolved Hide resolved
:members:

SimConfig
Expand Down
2 changes: 2 additions & 0 deletions pulser-simulation/pulser_simulation/simulation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1156,6 +1156,8 @@ def from_sequence(
class Simulation:
r"""Simulation of a pulse sequence using QuTiP.

Note: This class is deprecated in favour of `QutipEmulator.from_sequence`.

HGSilveri marked this conversation as resolved.
Show resolved Hide resolved
Args:
sequence: An instance of a Pulser Sequence that we
want to simulate.
Expand Down