c3 icon indicating copy to clipboard operation
c3 copied to clipboard

Toolset for control, calibration and characterization of physical systems

C3 - An integrated tool-set for Control, Calibration and Characterization

codecov Language grade: Python Build and Test Documentation Status Code style: black PyPI version fury.io PyPI license PyPI pyversions Binder

The C3 package is intended to close the loop between open-loop control optimization, control pulse calibration, and model-matching based on calibration data.

Installation

pip install c3-toolset

If you want to try out the bleeding edge (possibly buggy) version under development:

pip install c3-toolset-nightly

There is no official support for c3-toolset on Apple Silicon devices, but you can check the CONTRIBUTING.md for instructions on setting up an experimental version.

Usage

C3 provides a simple Python API through which it may integrate with virtually any experimental setup. Contact us at [email protected].

The paper introducing C3 as a scientific concept can be found in Wittler2021. Software and implementation details are described in SahaRoy2022.

Documentation is available here on RTD.

Examples

The following notebooks are available in the examples/ directory and can also be run online using the launch|binder badge above:

  • Model-based Optimal Control for Single Qubit Gate
  • Model-based Optimal Control for Two Qubit Engtangling Gate
  • Model-free Calibration on Simulated Hardware
  • Simulated Model Learning with data from Simulated Calibration
  • Full loop - Control, Calibration & Characterization
  • Minimum example for using the Qiskit interface
  • Minimum example for optimizing piece-wise constant pulses
  • Understanding the ParameterMap
  • Frequency Dependent Coupling

Contributing

If you wish to contribute, please check out the issues tab and also the CONTRIBUTING.md for useful resources.

The source code is available on Github at https://github.com/q-optimize/c3.

Citation

If you use c3-toolset in your research, please cite it as below:

@article{Wittler2021,
   title={Integrated Tool Set for Control, Calibration, and Characterization of Quantum Devices Applied to Superconducting Qubits},
   volume={15},
   DOI={10.1103/physrevapplied.15.034080},
   number={3},
   journal={Physical Review Applied},
   author={Wittler, Nicolas and Roy, Federico and Pack, Kevin and Werninghaus, Max and Saha Roy, Anurag and Egger, Daniel J. and Filipp, Stefan and Wilhelm, Frank K. and Machnes, Shai},
   year={2021},
   month={Mar}
}