Skip to content

Commit

Permalink
Merge pull request #1016 from qiboteam/docs
Browse files Browse the repository at this point in the history
Minimal docs to missing experiments
  • Loading branch information
Edoardo-Pedicillo authored Oct 29, 2024
2 parents dc66a50 + 301a571 commit cace06e
Show file tree
Hide file tree
Showing 10 changed files with 138 additions and 0 deletions.
Binary file added doc/source/protocols/chevron.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions doc/source/protocols/chevron.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Chevron
=======

Parameters
^^^^^^^^^^

.. autoclass::
qibocal.protocols.two_qubit_interaction.chevron.chevron.ChevronParameters
:noindex:

Example
^^^^^^^

Below is an example runcard for this experiment.

.. code-block:: yaml
- id: chevron
operation: chevron
parameters:
amplitude_max_factor: 1.1
amplitude_min_factor: 0.9
amplitude_step_factor: 0.01
duration_max: 51
duration_min: 4
duration_step: 2
The expected output is the following:

.. image:: chevron.png
Binary file added doc/source/protocols/coupler/chevron.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions doc/source/protocols/coupler/chevron.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Coupler Chevron
===============

Parameters
^^^^^^^^^^

.. autoclass::
qibocal.protocols.two_qubit_interaction.chevron.chevron.ChevronParameters
:noindex:


Example
^^^^^^^

Below is an example runcard for this experiment.

.. code-block:: yaml
- id: coupler chevron
operation: coupler_chevron
parameters:
amplitude_max_factor: 1.5
amplitude_min_factor: 0.4
amplitude_step_factor: 0.005
duration_max: 100
duration_min: 10
duration_step: 2
native: CZ
nshots: 256
relaxation_time: 100000
The expected output is the following:

.. image:: chevron.png
4 changes: 4 additions & 0 deletions doc/source/protocols/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,8 @@ In this section we introduce the basics of all protocols supported by ``qibocal`
avoided_crossing
readout_optimization
standard_rb
chevron
virtual_z
state_tomographies
coupler/chevron
references
40 changes: 40 additions & 0 deletions doc/source/protocols/state_tomographies.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
State Tomographies
==================

Parameters
^^^^^^^^^^

.. autoclass::
qibocal.protocols.state_tomography.StateTomographyParameters
:noindex:

Example
^^^^^^^

Below is an example runcard for this experiment.

.. code-block:: yaml
- id: state_tomography
operation: state_tomography
parameters:
nshots: 1024
relaxation_time: 200000
The expected output is the following:

.. image:: state_tomography.png


Qibocal also provides two qubit state tomography.

.. code-block:: yaml
- id: tomography
operation: two_qubit_state_tomography
parameters:
nshots: 5000
The report will look like the following.

.. image:: two_state_tomography.png
Binary file added doc/source/protocols/state_tomography.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/protocols/two_state_tomography.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/protocols/virtual_z.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions doc/source/protocols/virtual_z.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Virtual Z
=========

Parameters
^^^^^^^^^^

.. autoclass::
qibocal.protocols.two_qubit_interaction.virtual_z_phases.VirtualZPhasesParameters
:noindex:

Example
^^^^^^^

Below is an example runcard for this experiment.

.. code-block:: yaml
- id: cz
operation: cz_virtualz
parameters:
dt: 0
flux_pulse_duration: 70
theta_end: 6.5
theta_start: 0
theta_step: 0.5
The expected output is the following:

.. image:: virtual_z.png

0 comments on commit cace06e

Please sign in to comment.