docs: updated readme
Browse files
README.md
CHANGED
@@ -7,15 +7,40 @@ sdk: static
|
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
-
#
|
|
|
|
|
|
|
|
|
|
|
|
|
11 |
|
12 |
## Citation
|
13 |
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
|
18 |
-
|
19 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
20 |
}
|
21 |
-
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
+
# About SQuADDS
|
11 |
+
|
12 |
+
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.
|
13 |
+
|
14 |
+
# The SQuADDS Paper
|
15 |
+
|
16 |
+
Read the [SQuADDS Paper](https://quantum-journal.org/papers/q-2024-09-09-1465/) to learn more.
|
17 |
|
18 |
## Citation
|
19 |
|
20 |
+
If you use SQuADDS in your research, please cite the following paper:
|
21 |
+
|
22 |
+
```bibtex
|
23 |
+
@article{Shanto2024squaddsvalidated,
|
24 |
+
doi = {10.22331/q-2024-09-09-1465},
|
25 |
+
url = {https://doi.org/10.22331/q-2024-09-09-1465},
|
26 |
+
title = {{SQ}u{ADDS}: {A} validated design database and simulation workflow for superconducting qubit design},
|
27 |
+
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},
|
28 |
+
journal = {{Quantum}},
|
29 |
+
issn = {2521-327X},
|
30 |
+
publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
|
31 |
+
volume = {8},
|
32 |
+
pages = {1465},
|
33 |
+
month = sep,
|
34 |
+
year = {2024}
|
35 |
}
|
36 |
+
```
|
37 |
+
|
38 |
+
# Contribution
|
39 |
+
|
40 |
+
If you want to contribute to the **SQuADDS** project, please review the following resources:
|
41 |
+
|
42 |
+
- [How to Contribute to SQuADDS](https://lfl-lab.github.io/SQuADDS/source/resources/contribute.html)
|
43 |
+
- [Contributing Measured Data to SQuADDS](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial_4_Contributing_Measured_Data_to_SQuADDS.html)
|
44 |
+
- [Contributing Experimentally Validated Simulation Data](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3_Contributing_Validated_Simulation_Data_to_SQuADDS.html)
|
45 |
+
|
46 |
+
For any questions or further information, contact [Sadman Ahmed Shanto](mailto:[email protected]).
|