Update README.md

README.md

@@ -1,3 +1,65 @@
----
-license: unknown
----
+---
+license: mit
+configs:
+- config_name: qubit-TransmonCross-cap_matrix
+  data_files:
+  - split: train
+    path: "qubit-TransmonCross-cap_matrix.json"
+- config_name: cavity_claw-RouteMeander-eigenmode
+  data_files:
+  - split: train
+    path: "cavity_claw-RouteMeander-eigenmode.json"
+- config_name: coupler-NCap-cap_matrix
+  data_files:
+  - split: train
+    path: "coupler-NCap-cap_matrix.json"
+- config_name: coupler-CapNInterdigitalTee-cap_matrix
+  data_files:
+  - split: train
+    path: "coupler-CapNInterdigitalTee-cap_matrix.json"
+tags:
+- quantum
+- superconducting
+- qiskit-metal
+- qiskit
+- ibm
+- qubit
+- transmon
+- design
+- device
+- quantum-computing
+- quantum-hardware
+pretty_name: SQuADDS_DB
+size_categories:
+- 1K<n<10K
+---
+
+<center>
+  <img src="https://github.com/LFL-Lab/SQuADDS/blob/master/docs/_static/images/squadds_logo_dark_name.png?raw=true" width="80%" alt="SQuADDS Logo" /> <!-- This will stretch the logo to the full container width -->
+</center>
+
+# SQuADDS_DB - a Superconducting Qubit And Device Design and Simulation Database
+
+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.
+
+- **Homepage:** [https://lfl-lab.github.io/SQuADDS/](https://lfl-lab.github.io/SQuADDS/)
+- **Repository:** [https://github.com/lfl-lab/SQuADDS](https://github.com/lfl-lab/SQuADDS)
+- **Paper:** [https://arxiv.org/pdf/2312.13483.pdf](https://arxiv.org/pdf/2312.13483.pdf)
+- **Point of Contact:** [Sadman Ahmed Shanto](mailto:[email protected])
+
+If you use SQuADDS in your research, please cite the following paper:
+
+```bibtex
+    @article{SQuADDS,
+        title={SQuADDS: A validated design database and simulation workflow for superconducting qubit design},
+        author={Sadman Ahmed Shanto, Andre Kuo, Clark Miyamoto, Haimeng Zhang, Vivek Maurya, Evangelos Vlachos, Malida Hecht, Chung Wa Shum and Eli Levenson-Falk},
+        journal={arXiv preprint arXiv: https://arxiv.org/pdf/2312.13483.pdf},
+        year={2023}
+    }
+```
+
+---
+
+### Licensing Information
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.