updated README

README.md

@@ -30,74 +30,65 @@ size_categories:
 - 1K<n<10K
 ---
 
-# SQuADDS_DB - a Superconducting Qubit And Device Design and Simulation Database
-
-## Table of Contents
-- [Table of Contents](#table-of-contents)
-- [Dataset Description](#dataset-description)
-  - [Dataset Summary](#dataset-summary)
-- [Dataset Structure](#dataset-structure)
-  - [Data Instances](#data-instances)
-  - [Data Fields](#data-fields)
-  - [Data Splits](#data-splits)
-- [Dataset Creation](#dataset-creation)
-  - [Curation Rationale](#curation-rationale)
-  - [Source Data](#source-data)
-  - [Annotations](#annotations)
-  - [Personal and Sensitive Information](#personal-and-sensitive-information)
-- [Additional Information](#additional-information)
-  - [Dataset Curators](#dataset-curators)
-  - [Licensing Information](#licensing-information)
-  - [Citation Information](#citation-information)
-  - [Contributions](#contributions)
-
-## Dataset Description
-
-- **Homepage:** [https://sadmanahmedshanto.com/SQuADDS](https://sadmanahmedshanto.com/SQuADDS)
-- **Repository:** [https://github.com/shanto268/SQuADDS](https://github.com/shanto268/SQuADDS)
-- **Paper:** [arxiv](arxiv)
-- **Point of Contact:** [Sadman Ahmed Shanto](mailto:[email protected])
-
-### Dataset Summary
-
-[More Information Needed]
-
-## Dataset Structure
-
-Components -> Component_IDs -> Result_Type
-
-### Data Instances
-
-[More Information Needed]
-
-### Data Fields
+license: mit
+configs:
 
-[More Information Needed]
+- 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"
+    tags:
+- quantum
+- superconducting
+- qiskit-metal
+- qiskit
+- ibm
+- qubit
+- transmon
+- design
+- device
+- quantum-computing
+- quantum-hardware
+  pretty_name: SQuADDS_DB
+  size_categories:
+- 1K<n<10K
 
-### Data Splits
+---
 
-[More Information Needed]
+<center>
+  <img src="https://github.com/LFL-Lab/SQuADDS/blob/master/docs/_static/images/squadds_logo_dark_name.png" width="80%" alt="SQuADDS Logo" /> <!-- This will stretch the logo to the full container width -->
+</center>
 
-## Dataset Creation
+# SQuADDS_DB - a Superconducting Qubit And Device Design and Simulation Database
 
-### Curation Rationale
+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.
 
-[More Information Needed]
+- **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])
 
-## Additional Information
+If you use SQuADDS in your research, please cite the following paper:
 
-### Dataset Curators
+```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}
+    }
+```
 
-[More Information Needed]
+---
 
 ### Licensing Information
 
-[More Information Needed]
-
-### Citation Information
-
-[More Information Needed]
-
-### Contributions
-
-Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.