⚠️ 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
Install using pip:
pip install SQuADDSInstall from source:
- Clone the repository.
git clone https://github.com/LFL-Lab/SQuADDS.git- Install the required packages.
pip install -r requirements.txt- Run the setup script locally
pip install -e .- 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
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}
}Contributions are welcome! If you have improvements or additions to the database, please follow these steps:
- Fork the repository.
- Create a new branch for your feature.
- Add your contributions.
- Submit a pull request with a clear description of your changes.
This project is licensed under the MIT License - see the LICENSE file for details.
For inquiries or support, please contact Sadman Ahmed Shanto.