| Name | qfit JSON |
| Version |
2.0.3
JSON |
| download |
| home_page | None |
| Summary | qfit: data extraction GUI tool for use with scQubits |
| upload_time | 2024-05-06 23:00:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD 3-Clause License Copyright (c) 2020 and later, Jens Koch, Danyang Chen and Tianpu Zhao All rights reserved. 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 |
parameter extraction
superconducting qubits
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
scipy
matplotlib
pyside6
h5py
scikit-image
scqubits
qutip
matplotlib-label-lines
ipykernel
jupyter
pathos
dill
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
QFit: Interactive Parameter Fitting for Superconducting Circuits
================================================================
**Notice: This package is currently in beta testing. Bugs and issues are expected. We greatly appreciate your feedback and bug reports to help us improve.**
Developers: [Tianpu Zhao](https://github.com/ZhaoTianPu), [Danyang Chen](https://github.com/Harrinive), [Jens Koch](https://github.com/jkochNU)
UI/UX designer: [Tianying Lyu](https://tianyinglyu.com)
Overview
--------
QFit is your go-to Python application for extracting parameters of superconducting circuits from measured spectroscopy data. Following the four-step workflow, you can get your circuit parameters in no time:
1. **Calibration**: QFit helps to establish the mapping from voltage (your experimental tunable input) to circuit parameters (your simulation ingredients).
2. **Point Extraction**: With just a click, you can locate the peak of the spectrum sweep data with computer-assistance. The extracted data can be simply grouped as a transition and labeled. QFit even provides filters and coloring options for enhancing data visualization.
3. **Interactive Pre-fit**: See your numerical model result and the data on the same plot for intuitive comparison. Adjust the numerical simulator with simple sliders to improve your fit.
4. **Automated Fitting**: With one click, let the numerical optimizers do the work. You can easily configure your fitting: adjust which paramters are fixed or free, set their range, and more.
QFit supports a wide variety of circuit quantum electrodynamic systems, thanks to the powerful Python library `scqubits` as its backend simulator. Once you've extracted your parameters, you can pass them directly to scQubits for any further numerical simulations you need to do.
Join us in refining QFit during its beta phase! Your insights and reports are invaluable in making QFit a robust tool for this community. Dive in and explore what QFit can do for you, and let us know your experience!
Installation and Usage
----------------------
Follow these steps to install `QFit`:
1. (Optional but highly Recommended) Create a virtual environment with python (version > 3.10). If you are using conda, run on terminal
```
conda create -n <env name> python=3.10
conda activate <env name>
```
2. On terminal, install `QFit` by
```
pip install qfit
```
Once done, the application can be launched in a jupyter notebook session via
```
from qfit import Fit
Fit(<HilbertSpace>)
```
where `<HilbertSpace>` is a `scqubits.HilbertSpace` object, the circuit model you want to fit against.
Check out the notebook [QFit_Quick_Start.ipynb](./QFit_Quick_Start.ipynb) for a quick intro tutorial, and [QFit_Advanced_Tips.ipynb](./QFit_Advanced_Tips.ipynb) for further information.
License
-------
[](http://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_.28.22Revised_BSD_License.22.2C_.22New_BSD_License.22.2C_or_.22Modified_BSD_License.22.29)
You are free to use this software, with or without modification, provided that the conditions listed in the LICENSE file are satisfied.
qfit uses Qt library under license [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html).
qfit uses [CoreUI icons](https://coreui.io/docs/icons/) and [Font Awesome icons](https://fontawesome.com/icons) licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), and [SVG Reop icons](https://www.svgrepo.com) licensed under the MIT license.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions: The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Raw data
{
"_id": null,
"home_page": null,
"name": "qfit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "parameter extraction, superconducting qubits",
"author": null,
"author_email": "Tianpu Zhao <tianpuzhao2022@u.northwestern.edu>, Danyang Chen <danyangchen2026@u.northwestern.edu>, Jens Koch <jens-koch@northwestern.edu>",
"download_url": "https://files.pythonhosted.org/packages/84/19/f1c393e6ea5e3585a43d7604591a23913257812f3397e9727e25756bb18b/qfit-2.0.3.tar.gz",
"platform": null,
"description": "QFit: Interactive Parameter Fitting for Superconducting Circuits\n================================================================\n\n**Notice: This package is currently in beta testing. Bugs and issues are expected. We greatly appreciate your feedback and bug reports to help us improve.**\n\nDevelopers: [Tianpu Zhao](https://github.com/ZhaoTianPu), [Danyang Chen](https://github.com/Harrinive), [Jens Koch](https://github.com/jkochNU)\n\nUI/UX designer: [Tianying Lyu](https://tianyinglyu.com)\n\nOverview\n--------\nQFit is your go-to Python application for extracting parameters of superconducting circuits from measured spectroscopy data. Following the four-step workflow, you can get your circuit parameters in no time:\n\n1. **Calibration**: QFit helps to establish the mapping from voltage (your experimental tunable input) to circuit parameters (your simulation ingredients). \n\n2. **Point Extraction**: With just a click, you can locate the peak of the spectrum sweep data with computer-assistance. The extracted data can be simply grouped as a transition and labeled. QFit even provides filters and coloring options for enhancing data visualization.\n\n3. **Interactive Pre-fit**: See your numerical model result and the data on the same plot for intuitive comparison. Adjust the numerical simulator with simple sliders to improve your fit.\n\n4. **Automated Fitting**: With one click, let the numerical optimizers do the work. You can easily configure your fitting: adjust which paramters are fixed or free, set their range, and more.\n\nQFit supports a wide variety of circuit quantum electrodynamic systems, thanks to the powerful Python library `scqubits` as its backend simulator. Once you've extracted your parameters, you can pass them directly to scQubits for any further numerical simulations you need to do.\n\nJoin us in refining QFit during its beta phase! Your insights and reports are invaluable in making QFit a robust tool for this community. Dive in and explore what QFit can do for you, and let us know your experience!\n\nInstallation and Usage\n----------------------\n\nFollow these steps to install `QFit`:\n\n1. (Optional but highly Recommended) Create a virtual environment with python (version > 3.10). If you are using conda, run on terminal\n```\n conda create -n <env name> python=3.10\n conda activate <env name>\n```\n2. On terminal, install `QFit` by\n```\n pip install qfit\n```\nOnce done, the application can be launched in a jupyter notebook session via\n```\n from qfit import Fit\n Fit(<HilbertSpace>)\n```\nwhere `<HilbertSpace>` is a `scqubits.HilbertSpace` object, the circuit model you want to fit against.\n\nCheck out the notebook [QFit_Quick_Start.ipynb](./QFit_Quick_Start.ipynb) for a quick intro tutorial, and [QFit_Advanced_Tips.ipynb](./QFit_Advanced_Tips.ipynb) for further information.\n\nLicense\n-------\n[](http://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_.28.22Revised_BSD_License.22.2C_.22New_BSD_License.22.2C_or_.22Modified_BSD_License.22.29)\n\nYou are free to use this software, with or without modification, provided that the conditions listed in the LICENSE file are satisfied.\n\nqfit uses Qt library under license [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html).\n \nqfit uses [CoreUI icons](https://coreui.io/docs/icons/) and [Font Awesome icons](https://fontawesome.com/icons) licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), and [SVG Reop icons](https://www.svgrepo.com) licensed under the MIT license.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions: The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software. \n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2020 and later, Jens Koch, Danyang Chen and Tianpu Zhao All rights reserved. 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": "qfit: data extraction GUI tool for use with scQubits",
"version": "2.0.3",
"project_urls": {
"Repository": "https://github.com/scqubits/qfit",
"homepage": "https://github.com/scqubits/qfit"
},
"split_keywords": [
"parameter extraction",
" superconducting qubits"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4a71e9fd476ee30e16ea8881862214632c51fa58cfb1eb8a7dc62501e95963d",
"md5": "411b806855bd40b16d5bf05fab251c2b",
"sha256": "356770902b6a9ae350b683ad21cfeba391d5cbfb96511c5340d261578b850776"
},
"downloads": -1,
"filename": "qfit-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "411b806855bd40b16d5bf05fab251c2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7545299,
"upload_time": "2024-05-06T23:00:47",
"upload_time_iso_8601": "2024-05-06T23:00:47.741329Z",
"url": "https://files.pythonhosted.org/packages/f4/a7/1e9fd476ee30e16ea8881862214632c51fa58cfb1eb8a7dc62501e95963d/qfit-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8419f1c393e6ea5e3585a43d7604591a23913257812f3397e9727e25756bb18b",
"md5": "7d5bc5123174dc6a67f35493e232ae0f",
"sha256": "e8f3e567e95aa71b777497b5788149ae23c2fbffe70d29ebad7637f39e9415c2"
},
"downloads": -1,
"filename": "qfit-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "7d5bc5123174dc6a67f35493e232ae0f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 60922349,
"upload_time": "2024-05-06T23:00:50",
"upload_time_iso_8601": "2024-05-06T23:00:50.160063Z",
"url": "https://files.pythonhosted.org/packages/84/19/f1c393e6ea5e3585a43d7604591a23913257812f3397e9727e25756bb18b/qfit-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 23:00:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scqubits",
"github_project": "qfit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.14.2"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.1.2"
]
]
},
{
"name": "pyside6",
"specs": []
},
{
"name": "h5py",
"specs": [
[
">=",
"2.7.1"
]
]
},
{
"name": "scikit-image",
"specs": []
},
{
"name": "scqubits",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "qutip",
"specs": [
[
"<",
"5.0.0"
]
]
},
{
"name": "matplotlib-label-lines",
"specs": []
},
{
"name": "ipykernel",
"specs": []
},
{
"name": "jupyter",
"specs": []
},
{
"name": "pathos",
"specs": []
},
{
"name": "dill",
"specs": []
}
],
"lcname": "qfit"
}
