SQuADDS 0.3.2__tar.gz → 0.3.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {SQuADDS-0.3.2/SQuADDS.egg-info → SQuADDS-0.3.4}/PKG-INFO +32 -25
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/README.md +31 -24
- {SQuADDS-0.3.2 → SQuADDS-0.3.4/SQuADDS.egg-info}/PKG-INFO +32 -25
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/SQuADDS.egg-info/SOURCES.txt +1 -0
- SQuADDS-0.3.2/requirements.txt → SQuADDS-0.3.4/SQuADDS.egg-info/requires.txt +3 -1
- SQuADDS-0.3.2/SQuADDS.egg-info/requires.txt → SQuADDS-0.3.4/requirements.txt +2 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/setup.py +1 -1
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/__init__.py +1 -1
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/components/coupled_systems.py +3 -8
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/db.py +9 -2
- SQuADDS-0.3.4/squadds/database/github.py +292 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/simulations/objects.py +1 -1
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/LICENSE +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/MANIFEST.in +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/SQuADDS.egg-info/dependency_links.txt +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/SQuADDS.egg-info/top_level.txt +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/setup.cfg +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/calcs/__init__.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/calcs/qubit.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/calcs/transmon_cross.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/components/__init__.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/components/cavity_claw.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/components/claw_coupler.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/__init__.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/analysis.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/design_patterns.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/globals.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/metrics.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/processing.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/core/utils.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/HuggingFace.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/__init__.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/abstract_upload_data.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/checker.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/config.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/contributor.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/contributor_HF.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/new_contribution.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/database/utils.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/interpolations/__init__.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/interpolations/interpolator.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/interpolations/physics.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/simulations/__init__.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/simulations/ansys_simulator.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/simulations/simulator.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/simulations/sweeper_helperfunctions.py +0 -0
- {SQuADDS-0.3.2 → SQuADDS-0.3.4}/squadds/simulations/utils.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: SQuADDS
|
|
3
|
-
Version: 0.3.
|
|
3
|
+
Version: 0.3.4
|
|
4
4
|
Summary: Our project introduces an open-source database of programmatically generated and experimentally validated superconducting quantum device designs, accessible through a user-friendly interface, significantly lowering the entry barrier for research in this field.
|
|
5
5
|
Home-page: https://github.com/LFL-Lab/SQuADDS
|
|
6
6
|
Author: Sadman Ahmed Shanto
|
|
@@ -16,6 +16,7 @@ License-File: LICENSE
|
|
|
16
16
|
</center>
|
|
17
17
|
|
|
18
18
|
# Superconducting Qubit And Device Design and Simulation database     
|
|
19
|
+
|
|
19
20
|
> :warning: **This project is an alpha release and currently under active development. Some features and documentation may be incomplete. Please update to the latest release.**
|
|
20
21
|
|
|
21
22
|
The SQuADDS (Superconducting Qubit And Device Design and Simulation) Database Project is an open-source resource aimed at advancing research in superconducting quantum device designs. It provides a robust workflow for generating and simulating superconducting quantum device designs, facilitating the accurate prediction of Hamiltonian parameters across a wide range of design geometries.
|
|
@@ -74,8 +75,8 @@ Read more on [install_guide](docs/installation/unix_install.md))
|
|
|
74
75
|
|
|
75
76
|
- [Tutorial 1: Getting Started with SQuADDS](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-1_Getting_Started_with_SQuADDS.html)
|
|
76
77
|
- [Tutorial 2: Simulating Interpolated Designs](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-2_Simulate_interpolated_designs.html)
|
|
77
|
-
- [Tutorial 3: Contributing to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-
|
|
78
|
-
- [Tutorial
|
|
78
|
+
- [Tutorial 3: Contributing Experimentally-Validated Simulation Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3_Contributing_Validated_Simulation_Data_to_SQuADDS.html)
|
|
79
|
+
- [Tutorial 4: Contributing Measured Devices' Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial_4_Contributing_Measured_Data_to_SQuADDS.html)
|
|
79
80
|
- [(COMING SOON) More tutorials]()
|
|
80
81
|
|
|
81
82
|
## Citation
|
|
@@ -83,12 +84,19 @@ Read more on [install_guide](docs/installation/unix_install.md))
|
|
|
83
84
|
If you use SQuADDS in your research, please cite the following paper:
|
|
84
85
|
|
|
85
86
|
```bibtex
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
87
|
+
@article{Shanto2024squaddsvalidated,
|
|
88
|
+
doi = {10.22331/q-2024-09-09-1465},
|
|
89
|
+
url = {https://doi.org/10.22331/q-2024-09-09-1465},
|
|
90
|
+
title = {{SQ}u{ADDS}: {A} validated design database and simulation workflow for superconducting qubit design},
|
|
91
|
+
author = {Shanto, Sadman and Kuo, Andre and Miyamoto, Clark and Zhang, Haimeng and Maurya, Vivek and Vlachos, Evangelos and Hecht, Malida and Shum, Chung Wa and Levenson-Falk, Eli},
|
|
92
|
+
journal = {{Quantum}},
|
|
93
|
+
issn = {2521-327X},
|
|
94
|
+
publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
|
|
95
|
+
volume = {8},
|
|
96
|
+
pages = {1465},
|
|
97
|
+
month = sep,
|
|
98
|
+
year = {2024}
|
|
99
|
+
}
|
|
92
100
|
```
|
|
93
101
|
|
|
94
102
|
## Contributing
|
|
@@ -112,25 +120,24 @@ For inquiries or support, please contact [Sadman Ahmed Shanto](mailto:shanto@usc
|
|
|
112
120
|
## Contributors
|
|
113
121
|
|
|
114
122
|
|
|
115
|
-
| Name | Institution | Contribution
|
|
116
|
-
|
|
117
|
-
| Clark Miyamoto | New York University | Code contributor
|
|
118
|
-
| Madison Howard | California Institute of Technology | Bug Hunter
|
|
119
|
-
| Malida Hecht | University of Southern California | Data contributor
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
124
|
-
|
|
|
125
|
-
|
|
|
126
|
-
|
|
|
127
|
-
|
|
|
128
|
-
| Sara Sussman, PhD | Fermilab | Bug Hunter 🐛 |
|
|
123
|
+
| Name | Institution | Contribution |
|
|
124
|
+
|:-------------------|:-----------------------------------|:---------------------------------|
|
|
125
|
+
| Clark Miyamoto | New York University | Code contributor |
|
|
126
|
+
| Madison Howard | California Institute of Technology | Bug Hunter |
|
|
127
|
+
| Malida Hecht | University of Southern California | Data contributor |
|
|
128
|
+
| Anne Whelan | US Navy | Documentation contributor |
|
|
129
|
+
| Jenny Huang | Columbia University | Documentation contributor |
|
|
130
|
+
| Connie Miao | Stanford University | Data Contributor |
|
|
131
|
+
| Daria Kowsari, PhD | University of Southern California | Data contributor |
|
|
132
|
+
| Vivek Maurya | University of Southern California | Data contributor |
|
|
133
|
+
| Haimeng Zhang, PhD | IBM | Data contributor |
|
|
134
|
+
| Ethan Zheng | University of Southern California | Data contributor and Bug Hunter |
|
|
135
|
+
| Sara Sussman, PhD | Fermilab | Bug Hunter |
|
|
129
136
|
|
|
130
137
|
## Developers
|
|
131
|
-
- [shanto268](https://github.com/shanto268) -
|
|
138
|
+
- [shanto268](https://github.com/shanto268) - 245 contributions
|
|
132
139
|
- [elizabethkunz](https://github.com/elizabethkunz) - 17 contributions
|
|
133
140
|
- [NxtGenLegend](https://github.com/NxtGenLegend) - 1 contributions
|
|
141
|
+
- [ethanzhen7](https://github.com/ethanzhen7) - 1 contributions
|
|
134
142
|
---
|
|
135
143
|
|
|
136
|
-
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
</center>
|
|
4
4
|
|
|
5
5
|
# Superconducting Qubit And Device Design and Simulation database     
|
|
6
|
+
|
|
6
7
|
> :warning: **This project is an alpha release and currently under active development. Some features and documentation may be incomplete. Please update to the latest release.**
|
|
7
8
|
|
|
8
9
|
The SQuADDS (Superconducting Qubit And Device Design and Simulation) Database Project is an open-source resource aimed at advancing research in superconducting quantum device designs. It provides a robust workflow for generating and simulating superconducting quantum device designs, facilitating the accurate prediction of Hamiltonian parameters across a wide range of design geometries.
|
|
@@ -61,8 +62,8 @@ Read more on [install_guide](docs/installation/unix_install.md))
|
|
|
61
62
|
|
|
62
63
|
- [Tutorial 1: Getting Started with SQuADDS](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-1_Getting_Started_with_SQuADDS.html)
|
|
63
64
|
- [Tutorial 2: Simulating Interpolated Designs](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-2_Simulate_interpolated_designs.html)
|
|
64
|
-
- [Tutorial 3: Contributing to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-
|
|
65
|
-
- [Tutorial
|
|
65
|
+
- [Tutorial 3: Contributing Experimentally-Validated Simulation Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3_Contributing_Validated_Simulation_Data_to_SQuADDS.html)
|
|
66
|
+
- [Tutorial 4: Contributing Measured Devices' Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial_4_Contributing_Measured_Data_to_SQuADDS.html)
|
|
66
67
|
- [(COMING SOON) More tutorials]()
|
|
67
68
|
|
|
68
69
|
## Citation
|
|
@@ -70,12 +71,19 @@ Read more on [install_guide](docs/installation/unix_install.md))
|
|
|
70
71
|
If you use SQuADDS in your research, please cite the following paper:
|
|
71
72
|
|
|
72
73
|
```bibtex
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
74
|
+
@article{Shanto2024squaddsvalidated,
|
|
75
|
+
doi = {10.22331/q-2024-09-09-1465},
|
|
76
|
+
url = {https://doi.org/10.22331/q-2024-09-09-1465},
|
|
77
|
+
title = {{SQ}u{ADDS}: {A} validated design database and simulation workflow for superconducting qubit design},
|
|
78
|
+
author = {Shanto, Sadman and Kuo, Andre and Miyamoto, Clark and Zhang, Haimeng and Maurya, Vivek and Vlachos, Evangelos and Hecht, Malida and Shum, Chung Wa and Levenson-Falk, Eli},
|
|
79
|
+
journal = {{Quantum}},
|
|
80
|
+
issn = {2521-327X},
|
|
81
|
+
publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
|
|
82
|
+
volume = {8},
|
|
83
|
+
pages = {1465},
|
|
84
|
+
month = sep,
|
|
85
|
+
year = {2024}
|
|
86
|
+
}
|
|
79
87
|
```
|
|
80
88
|
|
|
81
89
|
## Contributing
|
|
@@ -99,25 +107,24 @@ For inquiries or support, please contact [Sadman Ahmed Shanto](mailto:shanto@usc
|
|
|
99
107
|
## Contributors
|
|
100
108
|
|
|
101
109
|
|
|
102
|
-
| Name | Institution | Contribution
|
|
103
|
-
|
|
104
|
-
| Clark Miyamoto | New York University | Code contributor
|
|
105
|
-
| Madison Howard | California Institute of Technology | Bug Hunter
|
|
106
|
-
| Malida Hecht | University of Southern California | Data contributor
|
|
107
|
-
|
|
|
108
|
-
|
|
|
109
|
-
|
|
|
110
|
-
|
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
| Sara Sussman, PhD | Fermilab | Bug Hunter 🐛 |
|
|
110
|
+
| Name | Institution | Contribution |
|
|
111
|
+
|:-------------------|:-----------------------------------|:---------------------------------|
|
|
112
|
+
| Clark Miyamoto | New York University | Code contributor |
|
|
113
|
+
| Madison Howard | California Institute of Technology | Bug Hunter |
|
|
114
|
+
| Malida Hecht | University of Southern California | Data contributor |
|
|
115
|
+
| Anne Whelan | US Navy | Documentation contributor |
|
|
116
|
+
| Jenny Huang | Columbia University | Documentation contributor |
|
|
117
|
+
| Connie Miao | Stanford University | Data Contributor |
|
|
118
|
+
| Daria Kowsari, PhD | University of Southern California | Data contributor |
|
|
119
|
+
| Vivek Maurya | University of Southern California | Data contributor |
|
|
120
|
+
| Haimeng Zhang, PhD | IBM | Data contributor |
|
|
121
|
+
| Ethan Zheng | University of Southern California | Data contributor and Bug Hunter |
|
|
122
|
+
| Sara Sussman, PhD | Fermilab | Bug Hunter |
|
|
116
123
|
|
|
117
124
|
## Developers
|
|
118
|
-
- [shanto268](https://github.com/shanto268) -
|
|
125
|
+
- [shanto268](https://github.com/shanto268) - 245 contributions
|
|
119
126
|
- [elizabethkunz](https://github.com/elizabethkunz) - 17 contributions
|
|
120
127
|
- [NxtGenLegend](https://github.com/NxtGenLegend) - 1 contributions
|
|
128
|
+
- [ethanzhen7](https://github.com/ethanzhen7) - 1 contributions
|
|
121
129
|
---
|
|
122
130
|
|
|
123
|
-
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: SQuADDS
|
|
3
|
-
Version: 0.3.
|
|
3
|
+
Version: 0.3.4
|
|
4
4
|
Summary: Our project introduces an open-source database of programmatically generated and experimentally validated superconducting quantum device designs, accessible through a user-friendly interface, significantly lowering the entry barrier for research in this field.
|
|
5
5
|
Home-page: https://github.com/LFL-Lab/SQuADDS
|
|
6
6
|
Author: Sadman Ahmed Shanto
|
|
@@ -16,6 +16,7 @@ License-File: LICENSE
|
|
|
16
16
|
</center>
|
|
17
17
|
|
|
18
18
|
# Superconducting Qubit And Device Design and Simulation database     
|
|
19
|
+
|
|
19
20
|
> :warning: **This project is an alpha release and currently under active development. Some features and documentation may be incomplete. Please update to the latest release.**
|
|
20
21
|
|
|
21
22
|
The SQuADDS (Superconducting Qubit And Device Design and Simulation) Database Project is an open-source resource aimed at advancing research in superconducting quantum device designs. It provides a robust workflow for generating and simulating superconducting quantum device designs, facilitating the accurate prediction of Hamiltonian parameters across a wide range of design geometries.
|
|
@@ -74,8 +75,8 @@ Read more on [install_guide](docs/installation/unix_install.md))
|
|
|
74
75
|
|
|
75
76
|
- [Tutorial 1: Getting Started with SQuADDS](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-1_Getting_Started_with_SQuADDS.html)
|
|
76
77
|
- [Tutorial 2: Simulating Interpolated Designs](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-2_Simulate_interpolated_designs.html)
|
|
77
|
-
- [Tutorial 3: Contributing to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-
|
|
78
|
-
- [Tutorial
|
|
78
|
+
- [Tutorial 3: Contributing Experimentally-Validated Simulation Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3_Contributing_Validated_Simulation_Data_to_SQuADDS.html)
|
|
79
|
+
- [Tutorial 4: Contributing Measured Devices' Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial_4_Contributing_Measured_Data_to_SQuADDS.html)
|
|
79
80
|
- [(COMING SOON) More tutorials]()
|
|
80
81
|
|
|
81
82
|
## Citation
|
|
@@ -83,12 +84,19 @@ Read more on [install_guide](docs/installation/unix_install.md))
|
|
|
83
84
|
If you use SQuADDS in your research, please cite the following paper:
|
|
84
85
|
|
|
85
86
|
```bibtex
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
87
|
+
@article{Shanto2024squaddsvalidated,
|
|
88
|
+
doi = {10.22331/q-2024-09-09-1465},
|
|
89
|
+
url = {https://doi.org/10.22331/q-2024-09-09-1465},
|
|
90
|
+
title = {{SQ}u{ADDS}: {A} validated design database and simulation workflow for superconducting qubit design},
|
|
91
|
+
author = {Shanto, Sadman and Kuo, Andre and Miyamoto, Clark and Zhang, Haimeng and Maurya, Vivek and Vlachos, Evangelos and Hecht, Malida and Shum, Chung Wa and Levenson-Falk, Eli},
|
|
92
|
+
journal = {{Quantum}},
|
|
93
|
+
issn = {2521-327X},
|
|
94
|
+
publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
|
|
95
|
+
volume = {8},
|
|
96
|
+
pages = {1465},
|
|
97
|
+
month = sep,
|
|
98
|
+
year = {2024}
|
|
99
|
+
}
|
|
92
100
|
```
|
|
93
101
|
|
|
94
102
|
## Contributing
|
|
@@ -112,25 +120,24 @@ For inquiries or support, please contact [Sadman Ahmed Shanto](mailto:shanto@usc
|
|
|
112
120
|
## Contributors
|
|
113
121
|
|
|
114
122
|
|
|
115
|
-
| Name | Institution | Contribution
|
|
116
|
-
|
|
117
|
-
| Clark Miyamoto | New York University | Code contributor
|
|
118
|
-
| Madison Howard | California Institute of Technology | Bug Hunter
|
|
119
|
-
| Malida Hecht | University of Southern California | Data contributor
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
124
|
-
|
|
|
125
|
-
|
|
|
126
|
-
|
|
|
127
|
-
|
|
|
128
|
-
| Sara Sussman, PhD | Fermilab | Bug Hunter 🐛 |
|
|
123
|
+
| Name | Institution | Contribution |
|
|
124
|
+
|:-------------------|:-----------------------------------|:---------------------------------|
|
|
125
|
+
| Clark Miyamoto | New York University | Code contributor |
|
|
126
|
+
| Madison Howard | California Institute of Technology | Bug Hunter |
|
|
127
|
+
| Malida Hecht | University of Southern California | Data contributor |
|
|
128
|
+
| Anne Whelan | US Navy | Documentation contributor |
|
|
129
|
+
| Jenny Huang | Columbia University | Documentation contributor |
|
|
130
|
+
| Connie Miao | Stanford University | Data Contributor |
|
|
131
|
+
| Daria Kowsari, PhD | University of Southern California | Data contributor |
|
|
132
|
+
| Vivek Maurya | University of Southern California | Data contributor |
|
|
133
|
+
| Haimeng Zhang, PhD | IBM | Data contributor |
|
|
134
|
+
| Ethan Zheng | University of Southern California | Data contributor and Bug Hunter |
|
|
135
|
+
| Sara Sussman, PhD | Fermilab | Bug Hunter |
|
|
129
136
|
|
|
130
137
|
## Developers
|
|
131
|
-
- [shanto268](https://github.com/shanto268) -
|
|
138
|
+
- [shanto268](https://github.com/shanto268) - 245 contributions
|
|
132
139
|
- [elizabethkunz](https://github.com/elizabethkunz) - 17 contributions
|
|
133
140
|
- [NxtGenLegend](https://github.com/NxtGenLegend) - 1 contributions
|
|
141
|
+
- [ethanzhen7](https://github.com/ethanzhen7) - 1 contributions
|
|
134
142
|
---
|
|
135
143
|
|
|
136
|
-
|
|
@@ -31,6 +31,7 @@ squadds/database/checker.py
|
|
|
31
31
|
squadds/database/config.py
|
|
32
32
|
squadds/database/contributor.py
|
|
33
33
|
squadds/database/contributor_HF.py
|
|
34
|
+
squadds/database/github.py
|
|
34
35
|
squadds/database/new_contribution.py
|
|
35
36
|
squadds/database/utils.py
|
|
36
37
|
squadds/interpolations/__init__.py
|
|
@@ -6,7 +6,7 @@ with open('requirements.txt') as f:
|
|
|
6
6
|
|
|
7
7
|
setup(
|
|
8
8
|
name='SQuADDS',
|
|
9
|
-
version='0.3.
|
|
9
|
+
version='0.3.4',
|
|
10
10
|
packages=find_packages(),
|
|
11
11
|
description='Our project introduces an open-source database of programmatically generated and experimentally validated superconducting quantum device designs, accessible through a user-friendly interface, significantly lowering the entry barrier for research in this field.',
|
|
12
12
|
long_description=open('README.md').read(),
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import warnings
|
|
2
1
|
from collections import OrderedDict
|
|
3
2
|
|
|
4
3
|
import numpy as np
|
|
@@ -64,12 +63,9 @@ class QubitCavity(QComponent):
|
|
|
64
63
|
self.make_qubit()
|
|
65
64
|
self.make_cavity()
|
|
66
65
|
self.make_pins()
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
)
|
|
71
|
-
# print("There may be \"kinks\" in the CPW. This is due to the ``asymmetry`` parameter in the CPW options. To remove the kinks, change the ``asymmetry`` parameter until the CPW is smooth.\nAlternatively, you may consider playing with the ``start_jogged_extension`` options")
|
|
72
|
-
|
|
66
|
+
print("There may be \"kinks\" in the CPW (a known issue from `qiskit-metal`). To remove the kinks, you can either:\n1. Adjust the `asymmetry` parameter.\n2. Modify the `start_jogged_extension` or `end_jogged_extension`.\n3. Change the `down_length` of the CoupledLineTee (CLT) component.\n4. Change the y-value of the CLT component by 20-50um until smooth.\nExperiment with these parameters to optimize the design.")
|
|
67
|
+
|
|
68
|
+
|
|
73
69
|
def make_qubit(self):
|
|
74
70
|
"""
|
|
75
71
|
Creates a qubit based on the specified qubit options.
|
|
@@ -218,7 +214,6 @@ class QubitCavity(QComponent):
|
|
|
218
214
|
LaunchpadWirebond
|
|
219
215
|
from qiskit_metal.qlibrary.tlines.straight_path import RouteStraight
|
|
220
216
|
p = self.p
|
|
221
|
-
print(self.coupler.options)
|
|
222
217
|
options = Dict(
|
|
223
218
|
orientation = -90,
|
|
224
219
|
pos_y = (float)(self.coupler.options.pos_y[:-2]) + 2.75,
|
|
@@ -299,6 +299,9 @@ class SQuADDS_DB(metaclass=SingletonMeta):
|
|
|
299
299
|
# Transpose the table (convert columns to rows)
|
|
300
300
|
table = list(map(list, zip(*table)))
|
|
301
301
|
|
|
302
|
+
# Remove duplicate entries in table
|
|
303
|
+
table = [list(x) for x in set(tuple(x) for x in table)]
|
|
304
|
+
|
|
302
305
|
# Print the table with headers
|
|
303
306
|
print(tabulate(table, headers=["Component", "Component Name", "Data Available", "Component Image"],tablefmt="grid"))
|
|
304
307
|
|
|
@@ -419,8 +422,8 @@ class SQuADDS_DB(metaclass=SingletonMeta):
|
|
|
419
422
|
all_devices_info = []
|
|
420
423
|
|
|
421
424
|
for entry in zip(dataset["contrib_info"], dataset["design_code"], dataset["paper_link"],
|
|
422
|
-
dataset["image"], dataset["foundry"], dataset["fabrication_recipe"]):
|
|
423
|
-
contrib_info, design_code, paper_link, image, foundry, recipe = entry
|
|
425
|
+
dataset["image"], dataset["foundry"], dataset["fabrication_recipe"], dataset["substrate"], dataset["materials"], dataset["junction_style"], dataset["junction_material"]):
|
|
426
|
+
contrib_info, design_code, paper_link, image, foundry, recipe, substrate, materials, junction_style, junction_materials = entry
|
|
424
427
|
|
|
425
428
|
device_info = {
|
|
426
429
|
"Name": contrib_info.get('name', 'N/A'),
|
|
@@ -428,6 +431,10 @@ class SQuADDS_DB(metaclass=SingletonMeta):
|
|
|
428
431
|
"Paper Link": paper_link,
|
|
429
432
|
"Image": image,
|
|
430
433
|
"Foundry": foundry,
|
|
434
|
+
"Substrate": substrate,
|
|
435
|
+
"Materials": materials,
|
|
436
|
+
"Junction Style": junction_style,
|
|
437
|
+
"Junction Materials": junction_materials,
|
|
431
438
|
# "Fabrication Recipe": recipe
|
|
432
439
|
}
|
|
433
440
|
all_devices_info.append(device_info)
|
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
import json
|
|
2
|
+
import os
|
|
3
|
+
import shutil
|
|
4
|
+
from datetime import date, datetime
|
|
5
|
+
|
|
6
|
+
import git
|
|
7
|
+
from dotenv import load_dotenv
|
|
8
|
+
from github import Github
|
|
9
|
+
from github.Auth import Auth
|
|
10
|
+
from github.GithubException import GithubException
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def login_to_github():
|
|
14
|
+
"""Logs in to GitHub using a token stored in environment variables."""
|
|
15
|
+
load_dotenv() # Load environment variables
|
|
16
|
+
github_token = os.getenv("GITHUB_TOKEN")
|
|
17
|
+
if github_token is None:
|
|
18
|
+
raise ValueError("GitHub token not found in environment variables.")
|
|
19
|
+
return Github(github_token)
|
|
20
|
+
|
|
21
|
+
def clone_repository(repo_url, clone_dir):
|
|
22
|
+
"""
|
|
23
|
+
Clone the given repository into the specified directory.
|
|
24
|
+
|
|
25
|
+
Parameters:
|
|
26
|
+
- repo_url (str): URL of the repository to clone.
|
|
27
|
+
- clone_dir (str): Path to the directory where the repo should be cloned.
|
|
28
|
+
|
|
29
|
+
Returns:
|
|
30
|
+
- git.Repo: The cloned Git repository object.
|
|
31
|
+
"""
|
|
32
|
+
# Remove the directory if it exists
|
|
33
|
+
if os.path.exists(clone_dir):
|
|
34
|
+
shutil.rmtree(clone_dir)
|
|
35
|
+
|
|
36
|
+
# Clone the repository
|
|
37
|
+
print(f"Cloning repository from {repo_url} into {clone_dir}...")
|
|
38
|
+
repo = git.Repo.clone_from(repo_url, clone_dir)
|
|
39
|
+
return repo
|
|
40
|
+
|
|
41
|
+
def fork_repository(github_token):
|
|
42
|
+
"""
|
|
43
|
+
Forks the specified GitHub repository to the authenticated user's account.
|
|
44
|
+
|
|
45
|
+
- github_token (str): GitHub Personal Access Token with appropriate permissions.
|
|
46
|
+
|
|
47
|
+
Returns:
|
|
48
|
+
- str: URL of the forked repository if successful, None otherwise.
|
|
49
|
+
"""
|
|
50
|
+
|
|
51
|
+
original_repo_name = "LFL-Lab/SQuADDS_DB"
|
|
52
|
+
# Authenticate with GitHub
|
|
53
|
+
g = Github(github_token)
|
|
54
|
+
|
|
55
|
+
# Get the authenticated user
|
|
56
|
+
user = g.get_user()
|
|
57
|
+
|
|
58
|
+
try:
|
|
59
|
+
# Get the original repository
|
|
60
|
+
original_repo = g.get_repo(original_repo_name)
|
|
61
|
+
|
|
62
|
+
# Fork the repository to the authenticated user's account
|
|
63
|
+
print(f"Forking the repository: {original_repo_name} to {user.login}'s account...")
|
|
64
|
+
forked_repo = user.create_fork(original_repo)
|
|
65
|
+
print(f"Repository forked successfully: {forked_repo.html_url}")
|
|
66
|
+
|
|
67
|
+
return forked_repo.html_url
|
|
68
|
+
|
|
69
|
+
except Exception as e:
|
|
70
|
+
print(f"Error forking repository: {e}")
|
|
71
|
+
return None
|
|
72
|
+
|
|
73
|
+
def read_json_file(file_path):
|
|
74
|
+
"""
|
|
75
|
+
Read and return the contents of the specified JSON file.
|
|
76
|
+
|
|
77
|
+
Parameters:
|
|
78
|
+
- file_path (str): Path to the JSON file.
|
|
79
|
+
|
|
80
|
+
Returns:
|
|
81
|
+
- dict: The contents of the JSON file as a Python dictionary.
|
|
82
|
+
"""
|
|
83
|
+
if not os.path.exists(file_path):
|
|
84
|
+
raise FileNotFoundError(f"File not found: {file_path}")
|
|
85
|
+
|
|
86
|
+
print(f"Reading JSON file from {file_path}...")
|
|
87
|
+
with open(file_path, 'r') as file:
|
|
88
|
+
data = json.load(file)
|
|
89
|
+
return data
|
|
90
|
+
|
|
91
|
+
def append_to_json(data, new_entry):
|
|
92
|
+
"""
|
|
93
|
+
Append the new entry to the JSON data, ensuring the format is maintained.
|
|
94
|
+
|
|
95
|
+
Parameters:
|
|
96
|
+
- data (dict): Existing JSON data.
|
|
97
|
+
- new_entry (dict): New entry to add to the JSON data.
|
|
98
|
+
|
|
99
|
+
Returns:
|
|
100
|
+
- dict: Updated JSON data.
|
|
101
|
+
"""
|
|
102
|
+
print("Appending new entry to JSON data...")
|
|
103
|
+
data.append(new_entry)
|
|
104
|
+
return data
|
|
105
|
+
|
|
106
|
+
def save_json_file(file_path, data):
|
|
107
|
+
"""
|
|
108
|
+
Save the updated data back to the JSON file.
|
|
109
|
+
|
|
110
|
+
Parameters:
|
|
111
|
+
- file_path (str): Path to the JSON file.
|
|
112
|
+
- data (dict): Updated JSON data.
|
|
113
|
+
"""
|
|
114
|
+
print(f"Saving updated JSON data to {file_path}...")
|
|
115
|
+
with open(file_path, 'w') as file:
|
|
116
|
+
json.dump(data, file, indent=4)
|
|
117
|
+
|
|
118
|
+
def commit_changes(repo, file_path, commit_message):
|
|
119
|
+
"""
|
|
120
|
+
Commit changes to the specified file in the repository.
|
|
121
|
+
|
|
122
|
+
Parameters:
|
|
123
|
+
- repo (git.Repo): The Git repository object.
|
|
124
|
+
- file_path (str): Path to the file to commit.
|
|
125
|
+
- commit_message (str): Commit message.
|
|
126
|
+
|
|
127
|
+
Returns:
|
|
128
|
+
- str: The commit hash if successful.
|
|
129
|
+
"""
|
|
130
|
+
print(f"Staging and committing changes to {file_path}...")
|
|
131
|
+
repo.git.add(file_path)
|
|
132
|
+
commit = repo.index.commit(commit_message)
|
|
133
|
+
print(f"Commit successful with message: {commit_message}")
|
|
134
|
+
return commit.hexsha
|
|
135
|
+
|
|
136
|
+
def push_changes(repo, branch_name='main', github_token=None):
|
|
137
|
+
"""
|
|
138
|
+
Push the committed changes to the remote repository.
|
|
139
|
+
|
|
140
|
+
Parameters:
|
|
141
|
+
- repo (git.Repo): The Git repository object.
|
|
142
|
+
- branch_name (str): The name of the branch to push to.
|
|
143
|
+
- github_token (str): GitHub Personal Access Token (optional).
|
|
144
|
+
|
|
145
|
+
Returns:
|
|
146
|
+
- bool: True if push is successful, False otherwise.
|
|
147
|
+
"""
|
|
148
|
+
try:
|
|
149
|
+
# Check and update remote URL if GitHub token is provided
|
|
150
|
+
if github_token:
|
|
151
|
+
# Construct the URL with the token for authentication
|
|
152
|
+
remote_url = repo.remotes.origin.url
|
|
153
|
+
if remote_url.startswith("https://"):
|
|
154
|
+
repo_name = remote_url.split("github.com/")[1]
|
|
155
|
+
authenticated_url = f"https://{github_token}@github.com/{repo_name}"
|
|
156
|
+
repo.remotes.origin.set_url(authenticated_url)
|
|
157
|
+
print(f"Updated remote URL with token for authentication")
|
|
158
|
+
else:
|
|
159
|
+
print("Remote URL is not HTTPS, cannot update with token.")
|
|
160
|
+
|
|
161
|
+
# Push changes to the remote repository
|
|
162
|
+
print(f"Pushing changes to the remote {branch_name} branch...")
|
|
163
|
+
push_result = repo.remote(name='origin').push(refspec=f'{branch_name}:{branch_name}')
|
|
164
|
+
print("Push successful.")
|
|
165
|
+
return True
|
|
166
|
+
except Exception as e:
|
|
167
|
+
print(f"Push failed: {e}")
|
|
168
|
+
return False
|
|
169
|
+
|
|
170
|
+
def contribute_measured_data(new_entry, pr_title="PR For Contributing New Data", pr_body="This PR is for contributing new data to the SQuADDS Measured Devices Database."):
|
|
171
|
+
"""
|
|
172
|
+
Update the JSON file in the given repository by appending a new entry and committing the changes.
|
|
173
|
+
|
|
174
|
+
Parameters:
|
|
175
|
+
- new_entry (dict): New entry to append to the JSON file.
|
|
176
|
+
- pr_title (str): The title of the pull request.
|
|
177
|
+
- pr_body (str): The body description of the pull request.
|
|
178
|
+
|
|
179
|
+
Returns:
|
|
180
|
+
- str: Commit hash if successful, None otherwise.
|
|
181
|
+
"""
|
|
182
|
+
# Variable setup
|
|
183
|
+
original_repo_name = "LFL-Lab/SQuADDS_DB"
|
|
184
|
+
TEMP_CLONE_DIR = "./temp_forked_repo"
|
|
185
|
+
json_file_path = "measured_device_database.json"
|
|
186
|
+
load_dotenv()
|
|
187
|
+
github_token = os.getenv("GITHUB_TOKEN")
|
|
188
|
+
if github_token is None:
|
|
189
|
+
raise ValueError("GitHub token not found in environment variables.")
|
|
190
|
+
gh_name = get_github_username(github_token)
|
|
191
|
+
forked_repo_name = f"{gh_name}/SQuADDS_DB"
|
|
192
|
+
branch_name = "main"
|
|
193
|
+
|
|
194
|
+
# Step 0: Fork the repository
|
|
195
|
+
forked_repo_url = fork_repository(github_token)
|
|
196
|
+
|
|
197
|
+
# Step 1: Clone the repository
|
|
198
|
+
repo = clone_repository(forked_repo_url, TEMP_CLONE_DIR)
|
|
199
|
+
|
|
200
|
+
# Step 2: Check out the main branch
|
|
201
|
+
print("Checking out the main branch...")
|
|
202
|
+
repo.git.checkout('main')
|
|
203
|
+
|
|
204
|
+
# Step 3: Read the JSON file
|
|
205
|
+
full_json_file_path = os.path.join(TEMP_CLONE_DIR, json_file_path)
|
|
206
|
+
data = read_json_file(full_json_file_path)
|
|
207
|
+
|
|
208
|
+
# Step 4: Append the new entry to the JSON data
|
|
209
|
+
updated_data = append_to_json(data, new_entry)
|
|
210
|
+
|
|
211
|
+
# Step 5: Save the updated JSON data back to the file
|
|
212
|
+
save_json_file(full_json_file_path, updated_data)
|
|
213
|
+
|
|
214
|
+
# Step 6: Commit the changes with a unique datetime-based message
|
|
215
|
+
commit_message = f"Update JSON dataset with new entry - {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
|
|
216
|
+
commit_hash = commit_changes(repo, json_file_path, commit_message)
|
|
217
|
+
|
|
218
|
+
# Step 7: Push the changes to the remote repository
|
|
219
|
+
if (push_changes(repo, "main", github_token)):
|
|
220
|
+
print("Successfully pushed changes to the remote repository.")
|
|
221
|
+
else:
|
|
222
|
+
print("Failed to push changes to the remote repository.")
|
|
223
|
+
return
|
|
224
|
+
|
|
225
|
+
# Step 8: Create a Pull Request on GitHub
|
|
226
|
+
pr_url = create_pull_request(forked_repo_name, branch_name, pr_title, pr_body, github_token)
|
|
227
|
+
print(f"Pull request URL: {pr_url}")
|
|
228
|
+
|
|
229
|
+
def create_pull_request(forked_repo_name, branch_name, pr_title, pr_body, github_token):
|
|
230
|
+
"""
|
|
231
|
+
Creates a pull request from the specified branch in the forked repository to the original repository.
|
|
232
|
+
|
|
233
|
+
Parameters:
|
|
234
|
+
- forked_repo_name (str): The full name of the forked repository (e.g., 'your_username/repo_name').
|
|
235
|
+
- branch_name (str): The name of the branch from which to create the PR.
|
|
236
|
+
- pr_title (str): The title of the pull request.
|
|
237
|
+
- pr_body (str): The body description of the pull request.
|
|
238
|
+
- github_token (str): GitHub Personal Access Token for authentication.
|
|
239
|
+
|
|
240
|
+
Returns:
|
|
241
|
+
- str: URL of the created pull request if successful, None otherwise.
|
|
242
|
+
"""
|
|
243
|
+
|
|
244
|
+
original_repo_name = "LFL-Lab/SQuADDS_DB"
|
|
245
|
+
|
|
246
|
+
# Authenticate with GitHub using the provided token
|
|
247
|
+
g = Github(github_token)
|
|
248
|
+
user = g.get_user()
|
|
249
|
+
|
|
250
|
+
try:
|
|
251
|
+
# Get the original repository
|
|
252
|
+
original_repo = g.get_repo(original_repo_name)
|
|
253
|
+
|
|
254
|
+
# Create a pull request
|
|
255
|
+
print(f"Creating a pull request from {forked_repo_name}:{branch_name} to {original_repo_name}:main...")
|
|
256
|
+
pull_request = original_repo.create_pull(
|
|
257
|
+
title=pr_title,
|
|
258
|
+
body=pr_body,
|
|
259
|
+
head=f"{user.login}:{branch_name}", # Forked repository and branch
|
|
260
|
+
base="main" # Target branch in the original repository
|
|
261
|
+
)
|
|
262
|
+
|
|
263
|
+
print("Pull request created successfully")
|
|
264
|
+
return pull_request.html_url
|
|
265
|
+
|
|
266
|
+
except Exception as e:
|
|
267
|
+
print(f"Error creating pull request: {e}")
|
|
268
|
+
return None
|
|
269
|
+
|
|
270
|
+
def get_github_username(github_token):
|
|
271
|
+
"""
|
|
272
|
+
Get the GitHub username associated with the provided token.
|
|
273
|
+
|
|
274
|
+
Parameters:
|
|
275
|
+
- github_token (str): GitHub Personal Access Token.
|
|
276
|
+
|
|
277
|
+
Returns:
|
|
278
|
+
- str: GitHub username if successful, None otherwise.
|
|
279
|
+
"""
|
|
280
|
+
try:
|
|
281
|
+
# Authenticate with GitHub using the token
|
|
282
|
+
g = Github(github_token)
|
|
283
|
+
|
|
284
|
+
# Get the authenticated user
|
|
285
|
+
user = g.get_user()
|
|
286
|
+
|
|
287
|
+
# Return the username
|
|
288
|
+
return user.login
|
|
289
|
+
|
|
290
|
+
except Exception as e:
|
|
291
|
+
print(f"Error retrieving GitHub username: {e}")
|
|
292
|
+
return None
|
|
@@ -266,7 +266,7 @@ def run_eigenmode(design, geometry_dict, sim_options):
|
|
|
266
266
|
mesh_lengths = {}
|
|
267
267
|
coupler_type = "CLT"
|
|
268
268
|
# "finger_count" in geometry_dict["cplr_opts"]
|
|
269
|
-
if geometry_dict['
|
|
269
|
+
if geometry_dict['cplr_opts'].get('finger_count') is not None :
|
|
270
270
|
coupler_type = "NCap"
|
|
271
271
|
render_simulation_no_ports(epra, [cpw,claw], [(cpw.name, "start")], config.design_name, setup.vars)
|
|
272
272
|
mesh_lengths = {'mesh1': {"objects": [f"trace_{cpw.name}", f"readout_connector_arm_{claw.name}"], "MaxLength": '4um'}}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|