qubit-discovery


Namequbit-discovery JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryTools to optimize superconducting circuits using SQcircuit.
upload_time2024-08-26 08:47:58
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseBSD 3-Clause License Copyright (c) 2024, Taha Rajabzadeh, Alex Boulton-McKeehan, Sam Bonkowsky, and Amir Safavi-Naeini Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords superconducting circuits superconducting qubits machine learning pytorch
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
  <img alt="Logo image" src="https://raw.githubusercontent.com/stanfordLINQS/Qubit-Discovery/main/pics/light_logo_qd.png" width="150" height="auto">
</div>

# qubit-discovery

qubit-discovery is an open-source Python library for optimizing superconducting circuits, built on top of [SQcircuit](https://sqcircuit.org/) and [PyTorch](https://pytorch.org/). It provides:
* Composable loss functions with a special focus on qubit design, and straightforward methods to add new custom ones.
* Fine-tuned BFGS and SGD algorithms to optimize circuits, along with an interface to use other PyTorch optimizers. 
* Utility features including random circuit sampling and functions to automatically choose circuit truncation numbers.

With these capabilities, you can easily optimize any superconducting circuit for decoherence time, anharmonicity, charge sensitivity, or other desired targets. 

A description of the theory involved and example application is provided in the following paper:
> Taha Rajabzadeh, Alex Boulton-McKeehan, Sam Bonkowsky, David I. Schuster, Amir H. Safavi-Naeini, "A General Framework for Gradient-Based Optimization of Superconducting Quantum Circuits using Qubit Discovery as a Case Study", arXiv:2408.12704 (2024), https://arxiv.org/abs/2408.12704.

If qubit-discovery is useful to you, we welcome contributions to its development and maintenance! Use of the package in publications may be acknowledged by citing the above paper.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "qubit-discovery",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "superconducting circuits, superconducting qubits, machine learning, pytorch",
    "author": null,
    "author_email": "Taha Rajabzadeh <tahar@stanford.edu>, Alex Boulton-McKeehan <mckeehan@stanford.edu>, Sam Bonkowsky <sbonkov@ucsb.edu>, Amir Safavi-Naeini <safavi@stanford.edu>",
    "download_url": "https://files.pythonhosted.org/packages/bc/f5/bf5d0c2f2957ed62c881d37adde034ccc93c044d8480c11dd79c53809168/qubit_discovery-1.0.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n  <img alt=\"Logo image\" src=\"https://raw.githubusercontent.com/stanfordLINQS/Qubit-Discovery/main/pics/light_logo_qd.png\" width=\"150\" height=\"auto\">\n</div>\n\n# qubit-discovery\n\nqubit-discovery is an open-source Python library for optimizing superconducting circuits, built on top of [SQcircuit](https://sqcircuit.org/) and [PyTorch](https://pytorch.org/). It provides:\n* Composable loss functions with a special focus on qubit design, and straightforward methods to add new custom ones.\n* Fine-tuned BFGS and SGD algorithms to optimize circuits, along with an interface to use other PyTorch optimizers. \n* Utility features including random circuit sampling and functions to automatically choose circuit truncation numbers.\n\nWith these capabilities, you can easily optimize any superconducting circuit for decoherence time, anharmonicity, charge sensitivity, or other desired targets. \n\nA description of the theory involved and example application is provided in the following paper:\n> Taha Rajabzadeh, Alex Boulton-McKeehan, Sam Bonkowsky, David I. Schuster, Amir H. Safavi-Naeini, \"A General Framework for Gradient-Based Optimization of Superconducting Quantum Circuits using Qubit Discovery as a Case Study\", arXiv:2408.12704 (2024), https://arxiv.org/abs/2408.12704.\n\nIf qubit-discovery is useful to you, we welcome contributions to its development and maintenance! Use of the package in publications may be acknowledged by citing the above paper.\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2024, Taha Rajabzadeh, Alex Boulton-McKeehan, Sam Bonkowsky, and Amir Safavi-Naeini  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Tools to optimize superconducting circuits using SQcircuit.",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/stanfordLINQS/Qubit-Discovery"
    },
    "split_keywords": [
        "superconducting circuits",
        " superconducting qubits",
        " machine learning",
        " pytorch"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "58e18fb43769a72137219975b477dcdbd990c0d960ca8c96b02721376a2b05de",
                "md5": "76d9a785f4c580c125d4436accd8ecfa",
                "sha256": "46ce978c9bd49f61eef35f3194068af0e05c9e8a4ce66d8291b57b61f93938ee"
            },
            "downloads": -1,
            "filename": "qubit_discovery-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "76d9a785f4c580c125d4436accd8ecfa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 38738,
            "upload_time": "2024-08-26T08:47:56",
            "upload_time_iso_8601": "2024-08-26T08:47:56.683848Z",
            "url": "https://files.pythonhosted.org/packages/58/e1/8fb43769a72137219975b477dcdbd990c0d960ca8c96b02721376a2b05de/qubit_discovery-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bcf5bf5d0c2f2957ed62c881d37adde034ccc93c044d8480c11dd79c53809168",
                "md5": "0f8af077e4aac79cd9f192ada785afc2",
                "sha256": "2322ca44da1558689bd44d75d5569cd3acd040ff933b2ee8c66305a91d024e05"
            },
            "downloads": -1,
            "filename": "qubit_discovery-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0f8af077e4aac79cd9f192ada785afc2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 416812,
            "upload_time": "2024-08-26T08:47:58",
            "upload_time_iso_8601": "2024-08-26T08:47:58.417656Z",
            "url": "https://files.pythonhosted.org/packages/bc/f5/bf5d0c2f2957ed62c881d37adde034ccc93c044d8480c11dd79c53809168/qubit_discovery-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-26 08:47:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stanfordLINQS",
    "github_project": "Qubit-Discovery",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "qubit-discovery"
}
        
Elapsed time: 1.51267s