{"id":13751207,"url":"https://github.com/q-optimize/c3","last_synced_at":"2025-05-09T17:33:22.674Z","repository":{"id":37398705,"uuid":"300285582","full_name":"q-optimize/c3","owner":"q-optimize","description":"Toolset for control, calibration and characterization of physical systems","archived":false,"fork":false,"pushed_at":"2024-03-05T12:47:05.000Z","size":32659,"stargazers_count":70,"open_issues_count":50,"forks_count":35,"subscribers_count":5,"default_branch":"dev","last_synced_at":"2025-04-18T09:43:29.856Z","etag":null,"topics":["calibration","characterization","control-systems","machine-learning","optimal-control","quantum-computing","quantum-information"],"latest_commit_sha":null,"homepage":"https://c3-toolset.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/q-optimize.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-01T13:16:00.000Z","updated_at":"2024-12-16T11:47:43.000Z","dependencies_parsed_at":"2024-01-15T01:04:10.794Z","dependency_job_id":"f4e32211-90a4-43ca-ab3d-ea3d0f67c0ce","html_url":"https://github.com/q-optimize/c3","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/q-optimize%2Fc3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/q-optimize%2Fc3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/q-optimize%2Fc3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/q-optimize%2Fc3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/q-optimize","download_url":"https://codeload.github.com/q-optimize/c3/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253295846,"owners_count":21885709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["calibration","characterization","control-systems","machine-learning","optimal-control","quantum-computing","quantum-information"],"created_at":"2024-08-03T09:00:39.001Z","updated_at":"2025-05-09T17:33:21.852Z","avatar_url":"https://github.com/q-optimize.png","language":"Python","funding_links":[],"categories":["Community","Quantum control"],"sub_categories":[],"readme":"# C3 - An integrated tool-set for Control, Calibration and Characterization\n\n[![codecov](https://codecov.io/gh/q-optimize/c3/branch/dev/graph/badge.svg)](https://codecov.io/gh/q-optimize/c3)\n[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/q-optimize/c3.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/q-optimize/c3/context:python)\n\u003ca href=\"https://codeclimate.com/github/q-optimize/c3/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/a090831b106f863dc223/maintainability\" /\u003e\u003c/a\u003e\n[![Build and Test](https://github.com/q-optimize/c3/actions/workflows/build_package.yml/badge.svg)](https://github.com/q-optimize/c3/actions/workflows/build_package.yml)\n[![Documentation Status](https://readthedocs.org/projects/c3-toolset/badge/?version=latest)](https://c3-toolset.readthedocs.io/en/latest/?badge=latest)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![PyPI version fury.io](https://badge.fury.io/py/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)\n[![PyPI license](https://img.shields.io/pypi/l/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/q-optimize/c3/dev)\n\nThe C3 package is intended to close the loop between open-loop control optimization, control pulse calibration, and model-matching based on calibration data.\n\n## Installation\n\n```bash\npip install c3-toolset\n```\n\nIf you want to try out the bleeding edge (possibly buggy) version under development:\n\n```bash\npip install c3-toolset-nightly\n```\n\nThere is no official support for `c3-toolset` on Apple Silicon devices, but you can check the [`CONTRIBUTING.md`](CONTRIBUTING.md#development-on-apple-silicon) for instructions on setting up an experimental version.\n\n## Usage\n\nC3  provides a simple Python API through which it may integrate with virtually any experimental setup.\nContact us at [c3@q-optimize.org](mailto://quantum.c3po@gmail.com).\n\nThe paper introducing C3 as a scientific concept can be found in [Wittler2021](https://arxiv.org/abs/2009.09866). Software and implementation details are described in [SahaRoy2022](https://arxiv.org/abs/2205.04829). \n\nDocumentation is available [here](https://c3-toolset.readthedocs.io) on RTD.\n\n### Examples\n\nThe following notebooks are available in the `examples/` directory and can also be run online using the `launch|binder` badge above:\n\n- [Model-based Optimal Control for Single Qubit Gate](examples/two_qubits.ipynb)\n- [Model-based Optimal Control for Two Qubit Engtangling Gate](examples/two_qubit_entangling_gate.ipynb)\n- [Model-free Calibration on Simulated Hardware](examples/Simulated_calibration.ipynb)\n- [Simulated Model Learning with data from Simulated Calibration](examples/Simulated_Model_Learning.ipynb)\n- [Full loop - Control, Calibration \u0026 Characterization](examples/Full_loop_single_qubit.ipynb)\n- [Minimum example for using the Qiskit interface](examples/c3_qiskit.ipynb)\n- [Minimum example for optimizing piece-wise constant pulses](examples/Piecewise_constant_controls.ipynb)\n- [Understanding the ParameterMap](examples/Parametermap.ipynb)\n- [Frequency Dependent Coupling](examples/frequency_dependent_coupling.ipynb)\n\n## Contributing\n\nIf you wish to contribute, please check out the issues tab and also the [CONTRIBUTING.md](CONTRIBUTING.md) for useful resources.\n\nThe source code is available on Github at [https://github.com/q-optimize/c3](https://github.com/q-optimize/c3).\n\n## Citation\n\nIf you use `c3-toolset` in your research, please cite it as below:\n\n```\n@article{Wittler2021,\n   title={Integrated Tool Set for Control, Calibration, and Characterization of Quantum Devices Applied to Superconducting Qubits},\n   volume={15},\n   DOI={10.1103/physrevapplied.15.034080},\n   number={3},\n   journal={Physical Review Applied},\n   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},\n   year={2021},\n   month={Mar}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fq-optimize%2Fc3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fq-optimize%2Fc3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fq-optimize%2Fc3/lists"}