C3 - An integrated tool-set for Control, Calibration and Characterization
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 c3@q-optimize.org.
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}
}
1 maintainer
Metadata
1 maintainer
Release files for c3-toolset-nightly 20220925
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| c3-toolset-nightly-20220925.tar.gz | 126.1 kB | Without provenance | Details for c3-toolset-nightly-20220925.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| c3_toolset_nightly-20220925-py3-none-any.whl | Python 3 | none | any | Details for c3_toolset_nightly-20220925-py3-none-any.whl |
Total release size: 242.7 kB
Release files / c3-toolset-nightly-20220925.tar.gz
| Download URL | c3-toolset-nightly-20220925.tar.gz |
|---|---|
| Size | 126.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e4a0f5e8723f879763b0058d841d66ee7185a3703414f7eeeab3cddecc4d3ee0
|
|
BLAKE2b-256 checksum How to use checksums |
ff6bd6cebed1faef5355e1ec7ca887064feab45659fafc4ad9f8fc880190ccfa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.14
|
Release files / c3_toolset_nightly-20220925-py3-none-any.whl
| Download URL | c3_toolset_nightly-20220925-py3-none-any.whl |
|---|---|
| Size | 116.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
049be57e5ebf6f601c0532be18418274894373013e1721da0e1cbf402be3e8d0
|
|
BLAKE2b-256 checksum How to use checksums |
a8551c7d6f19dfb5f1b7ebe4cb12a76b6b39f2c7ef1412fb6936f1c6bc53f9de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.14
|
Security for c3-toolset-nightly 20220925
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
