Update links and add citation

LFL-Lab · Jan 11, 2024 · 7510376 · 7510376
1 parent cd4551c
commit 7510376
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -8,17 +8,19 @@
 
 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.
 
-Paper Link: [SQuADDS: A Database for Superconducting Quantum Device Design and Simulation](https://arxiv.org/pdf/2312.13483.pdf)
-Website Link: [SQuADDS](https://lfl-lab.github.io/SQuADDS/)
+**Paper Link:** [SQuADDS: A Database for Superconducting Quantum Device Design and Simulation](https://arxiv.org/pdf/2312.13483.pdf)
+
+**Website Link:** [SQuADDS](https://lfl-lab.github.io/SQuADDS/)
 
 ## Table of Contents
 
-- [Setup](#setup)
-- [Features](#features)
-- [Usage](#usage)
+- [Installation](#installation)
+- [Tutorials](#tutorials)
+- [Citation](#citation)
 - [Contributing](#contributing)
 - [License](#license)
 - [Contact](#contact)
+- [Next Release:](#next-release)
 
 ---
 
@@ -61,6 +63,19 @@ pip install -e .
 - [(COMING SOON) Tutorial 5: Creating your own Interpolater]()
 - [(COMING SOON) Tutorial 6: Creating your own Simulator]()
 
+## Citation
+
+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}
+    }
+```
+
 ## Contributing
 
 Contributions are welcome! If you have improvements or additions to the database, please follow these steps:

diff --git a/docs/index.rst b/docs/index.rst
@@ -24,9 +24,9 @@ SQuADDS is an open-source platform aimed at speeding up the design loop in the c
    Developer Notes <source/developer/index>
    Simulation Notes <source/resources/simulations>
    Release Logs<source/release_notes>
-   GitHub <https://github.com/shanto268/SQuADDS>
-   Paper <https://arxiv.org/pdf/2312.13483.pdf>
    References<source/references/index>
+   GitHub <https://github.com/lfl-lab/SQuADDS>
+   Paper <https://arxiv.org/pdf/2312.13483.pdf>
    LFL Lab ✌️<https://dornsife.usc.edu/lfl/>
 
 

diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst
@@ -1,13 +1,18 @@
 Tutorials
 =========
 
+.. warning::
+
+   Tutorials 3 is currently under active construction 🛠️. Please stay tuned 🙏🏽 
+
 .. toctree::
    :maxdepth: 1
 
    Tutorial-1_Getting_Started_with_SQuADDS.ipynb
    Tutorial-2_Simulate_interpolated_designs.ipynb
    Tutorial-3_Contributing_to_SQuADDS.ipynb
 
-| Tutorials 3 is currently under construction 🛠️. Please stay tuned 🙏🏽 
 
-| More Tutorials Coming Soon!
+.. note::
+
+   More Tutorials Coming Soon!