c3-toolset-nightly


Namec3-toolset-nightly JSON
Version 20230126 PyPI version JSON
download
home_pagehttp://www.q-optimize.org
SummaryToolset for control, calibration and characterization of physical systems
upload_time2023-01-26 09:50:36
maintainer
docs_urlNone
authorq-optimize
requires_python~=3.7
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # C3 - An integrated tool-set for Control, Calibration and Characterization

[![codecov](https://codecov.io/gh/q-optimize/c3/branch/dev/graph/badge.svg)](https://codecov.io/gh/q-optimize/c3)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/q-optimize/c3.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/q-optimize/c3/context:python)
<a href="https://codeclimate.com/github/q-optimize/c3/maintainability"><img src="https://api.codeclimate.com/v1/badges/a090831b106f863dc223/maintainability" /></a>
[![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)
[![Documentation Status](https://readthedocs.org/projects/c3-toolset/badge/?version=latest)](https://c3-toolset.readthedocs.io/en/latest/?badge=latest)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI version fury.io](https://badge.fury.io/py/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)
[![PyPI license](https://img.shields.io/pypi/l/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/q-optimize/c3/dev)

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

```bash
pip install c3-toolset
```

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

```bash
pip install c3-toolset-nightly
```

There 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.

## Usage

C3  provides a simple Python API through which it may integrate with virtually any experimental setup.
Contact us at [c3@q-optimize.org](mailto://quantum.c3po@gmail.com).

The 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). 

Documentation is available [here](https://c3-toolset.readthedocs.io) 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](examples/two_qubits.ipynb)
- [Model-based Optimal Control for Two Qubit Engtangling Gate](examples/two_qubit_entangling_gate.ipynb)
- [Model-free Calibration on Simulated Hardware](examples/Simulated_calibration.ipynb)
- [Simulated Model Learning with data from Simulated Calibration](examples/Simulated_Model_Learning.ipynb)
- [Full loop - Control, Calibration & Characterization](examples/Full_loop_single_qubit.ipynb)
- [Minimum example for using the Qiskit interface](examples/c3_qiskit.ipynb)
- [Minimum example for optimizing piece-wise constant pulses](examples/Piecewise_constant_controls.ipynb)
- [Understanding the ParameterMap](examples/Parametermap.ipynb)
- [Frequency Dependent Coupling](examples/frequency_dependent_coupling.ipynb)

## Contributing

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

The source code is available on Github at [https://github.com/q-optimize/c3](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}
}
```



            

Raw data

            {
    "_id": null,
    "home_page": "http://www.q-optimize.org",
    "name": "c3-toolset-nightly",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "~=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "q-optimize",
    "author_email": "c3@q-optimize.org",
    "download_url": "https://files.pythonhosted.org/packages/b1/9c/0495d455ca068dba9372288fe88dbfeef9e876f092e9e50f894c01051126/c3-toolset-nightly-20230126.tar.gz",
    "platform": null,
    "description": "# 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&logoWidth=18)](https://lgtm.com/projects/g/q-optimize/c3/context:python)\n<a href=\"https://codeclimate.com/github/q-optimize/c3/maintainability\"><img src=\"https://api.codeclimate.com/v1/badges/a090831b106f863dc223/maintainability\" /></a>\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 & 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\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Toolset for control, calibration and characterization of physical systems",
    "version": "20230126",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ea4cf9f17b76f573ef0caf927bf5b05e0e4338d334f3fa5ce237fd6f2620238c",
                "md5": "f270851cf1fc57d178f5ea8977296211",
                "sha256": "d16e503f70cfc82d319ae61bd28778da03e3b6b53a69a2546a8028f72b2a01d5"
            },
            "downloads": -1,
            "filename": "c3_toolset_nightly-20230126-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f270851cf1fc57d178f5ea8977296211",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.7",
            "size": 116620,
            "upload_time": "2023-01-26T09:50:33",
            "upload_time_iso_8601": "2023-01-26T09:50:33.611793Z",
            "url": "https://files.pythonhosted.org/packages/ea/4c/f9f17b76f573ef0caf927bf5b05e0e4338d334f3fa5ce237fd6f2620238c/c3_toolset_nightly-20230126-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b19c0495d455ca068dba9372288fe88dbfeef9e876f092e9e50f894c01051126",
                "md5": "3bccc1ef3da27ef78032d91cde950be8",
                "sha256": "1189b068af9d594b658f83c95a4a7cf7b63f83798c028d5824df44bd9dd7843f"
            },
            "downloads": -1,
            "filename": "c3-toolset-nightly-20230126.tar.gz",
            "has_sig": false,
            "md5_digest": "3bccc1ef3da27ef78032d91cde950be8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.7",
            "size": 126054,
            "upload_time": "2023-01-26T09:50:36",
            "upload_time_iso_8601": "2023-01-26T09:50:36.157256Z",
            "url": "https://files.pythonhosted.org/packages/b1/9c/0495d455ca068dba9372288fe88dbfeef9e876f092e9e50f894c01051126/c3-toolset-nightly-20230126.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-26 09:50:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "c3-toolset-nightly"
}
        
Elapsed time: 0.04490s