Skip to content

Commit 2217a96

Browse files
committed
Added example to documentation.
1 parent 04413bb commit 2217a96

8 files changed

+746
-7
lines changed

docs/c3po.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
C3 software package
2-
===================
1+
API Documentation
2+
=================
33

44
C3objs
55
------

docs/conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
# ones.
2929
extensions = [
3030
"autoapi.extension",
31+
"sphinx.ext.napoleon",
32+
"sphinx.ext.viewcode"
3133
]
3234

3335
autoapi_dirs = ["../"]

docs/dyn_10X.png

41.7 KB
Loading

docs/dyn_5X.png

33.3 KB
Loading

docs/dyn_singleX.png

23.6 KB
Loading

docs/index.rst

+15-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,24 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
C3 - An integrated tool-set for control, calibration and characterization!
7-
===========================================================================
6+
:math:`C^3` - An integrated tool-set for control, calibration and characterization
7+
===================================================================================
8+
9+
The :math:`C^3` software package provides tools to simulate and interact with experiments to perform common control and characterization tasks. Modules can be used individually or combined to achieve a certain goal. The main focus are three optimizations:
10+
11+
* :math:`C_1` Open-loop optimal control: Given a model, find the pulse shapes which maximize fidelity with a target operation.
12+
* :math:`C_2` Closed-loop calibration: Given pulses, calibrate their parameters to maximize a figure of merit measured by the actual experiment, thus improving beyond the limits of a deficient model.
13+
* :math:`C_3` Model learning: Given control pulses and their experimental measurement outcome, optimize model parameters to best reproduce the results.
14+
15+
When combined in sequence, these three procedures represent a recipe for system characterization.
16+
17+
*Note: This documentation is work-in-progress.*
818

919
.. toctree::
1020
:maxdepth: 4
11-
:caption: API documentation:
12-
21+
:caption: Contents:
22+
23+
two_qubits
1324
c3po
1425

1526

0 commit comments

Comments
 (0)