Superconducting Qubit And Device Design and Simulation database

⚠️ This project is an alpha release and currently under active development. Some features and documentation may be incomplete. Please update to the latest release.

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

Website Link: SQuADDS

Table of Contents

• Installation
• Tutorials
• Citation
• Contributing
• License
• Contact

---

Setup

Install using pip:

pip install SQuADDS

Install from source:

1. Clone Repository: Navigate to your chosen directory and clone the repository.

cd <REPO-PATH>
git clone https://github.com/LFL-Lab/SQuADDS.git

2. Install Dependencies: Activate a clean conda environment (with qiskit-metal) and install dependencies.

conda activate <YOUR-ENV>
cd SQuADDS
pip install -r requirements.txt
pip install -e .

Install on a fresh Mac/Linux system:

Read more on install_guide)

Tutorials

• Tutorial 1: Getting Started with SQuADDS
• Tutorial 2: Simulating Interpolated Designs
• Tutorial 3: Contributing to the SQuADDS Database
• (COMING SOON) Tutorial 4: Creating a new database schema for SQuADDS

Citation

If you use SQuADDS in your research, please cite the following paper:

    @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

We welcome contributions from the community! Here is our work wish list.

Please see our Contributing Guidelines for more information on how to get started and absolutely feel free to reach out to us if you have any questions.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For inquiries or support, please contact Sadman Ahmed Shanto.

---