-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.rst
72 lines (47 loc) · 2.14 KB
/
index.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.. title::
Qibocal
What is Qibocal?
================
Qibocal is a python module that implements Quantum Characterization Validation and Verification using
`Qibo <https://github.com/qiboteam/qibo>`_ and `Qibolab <https://github.com/qiboteam/qibolab>`_.
Protocols
---------
Here is a scheme with the protocols currently available in Qibocal:
.. image:: getting-started/qpu_characterization.svg
Key features
------------
* Automatization of calibration routines.
* Declarative inputs using runcard.
* Generation of a report.
How to Use the Documentation
============================
Welcome to the comprehensive documentation for Qibocal! This guide will help you navigate through the various sections and make the most of the resources available.
1. **Installation and Setup**: Begin by referring to the :doc:`/getting-started/installation` guide to set up the Qibocal library in your environment.
2. **Tutorials**: Explore the :doc:`/tutorials/index` section for a range of tutorials that cater to different levels of expertise. These tutorials cover basic examples, real experiments, and guides for extending the library with new instruments.
3. **API Reference**: For an in-depth exploration, visit the :doc:`/api-reference/qibocal` section. Here, you'll find automatically compiled documentation generated from present docstrings. This reference offers comprehensive insights into the various classes, methods, and attributes available within the library.
Contents
========
.. toctree::
:maxdepth: 2
:caption: Introduction
getting-started/index
.. toctree::
:maxdepth: 2
:caption: Tutorials
tutorials/index
.. toctree::
:maxdepth: 2
:caption: Main documentation
api-reference/modules
Developer guides <https://qibo.science/qibo/stable/developer-guides/index.html>
.. toctree::
:maxdepth: 1
:caption: Documentation links
Qibo docs <https://qibo.science/qibo/stable/>
Qibolab docs <https://qibo.science/qibolab/stable/>
Qibocal docs <https://qibo.science/qibocal/stable/>
Qibosoq docs <https://qibo.science/qibosoq/stable/>
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`