Metadata-Version: 2.1
Name: SQuADDS
Version: 0.3.2
Summary: Our project introduces an open-source database of programmatically generated and experimentally validated superconducting quantum device designs, accessible through a user-friendly interface, significantly lowering the entry barrier for research in this field.
Home-page: https://github.com/LFL-Lab/SQuADDS
Author: Sadman Ahmed Shanto
Author-email: shanto@usc.edu
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

<center>
  <img src="docs/_static/images/squadds_not_transparent.png" width="100%" alt="SQuADDS Logo" /> <!-- This will stretch the logo to the full container width -->
</center>

# Superconducting Qubit And Device Design and Simulation database ![Version](https://img.shields.io/github/v/release/LFL-Lab/SQuADDS) ![Pepy Total Downlods](https://img.shields.io/pepy/dt/squadds) ![Build Status](https://img.shields.io/github/actions/workflow/status/LFL-Lab/SQuADDS/ci.yml?branch=master) ![License](https://img.shields.io/github/license/LFL-Lab/SQuADDS) ![Alpha Version](https://img.shields.io/badge/Status-Alpha%20Version-yellow)
> :warning: **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](https://arxiv.org/pdf/2312.13483.pdf)

**Website Link:** [SQuADDS](https://lfl-lab.github.io/SQuADDS/)

## Table of Contents

- [Installation](#setup)
- [Tutorials](#tutorials)
- [Citation](#citation)
- [Contributing](#contributing)
- [License](#license)
- [FAQs](#faqs)
- [Contact](#contact)
- [Contributors](#contributors)
- [Developers](#developers)

---

## Setup

**Install using pip:**

```bash
pip install SQuADDS
```

**Install from source:**

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

```bash
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.

```bash
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](docs/installation/unix_install.md))

## Tutorials

- [Tutorial 1: Getting Started with SQuADDS](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-1_Getting_Started_with_SQuADDS.html)
- [Tutorial 2: Simulating Interpolated Designs](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-2_Simulate_interpolated_designs.html)
- [Tutorial 3: Contributing to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3_Contributing_to_SQuADDS.html)
- [Tutorial 3p5: Creating a new dataset for SQuADDS](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3p5_Creating_a_new_dataset.html)
- [(COMING SOON) More tutorials]()

## 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

We welcome contributions from the community! Here is our [work wish list](wish_list.md).

Please see our [Contributing Guidelines](CONTRIBUTING.md) 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](LICENSE) file for details.

## FAQs

Check out our [FAQs](https://lfl-lab.github.io/SQuADDS/source/getting_started.html#faq-s) for common questions and answers.

## Contact

For inquiries or support, please contact [Sadman Ahmed Shanto](mailto:shanto@usc.edu).

## Contributors


| Name               | Institution                        | Contribution                        |
|:-------------------|:-----------------------------------|:------------------------------------|
| Clark Miyamoto     | New York University                | Code contributor 💻                  |
| Madison Howard     | California Institute of Technology | Bug Hunter 🐛                        |
| Malida Hecht       | University of Southern California  | Data contributor 📀                  |
| Evangelos Vlachos  | University of Southern California  | Code contributor 💻 and Bug Hunter 🐛 |
| Anne Whelan        | US Navy                            | Documentation contributor 📄         |
| Jenny Huang        | Columbia University                | Documentation contributor 📄         |
| Connie Miao        | Stanford University                | Data Contributor 📀                  |
| Daria Kowsari, PhD | University of Southern California  | Data contributor 📀                  |
| Vivek Maurya       | University of Southern California  | Data contributor 📀                  |
| Haimeng Zhang, PhD | IBM                                | Data contributor 📀                  |
| Ethan Zheng        | University of Southern California  | Data contributor 📀                  |
| Sara Sussman, PhD  | Fermilab                           | Bug Hunter 🐛                        |

## Developers
- [shanto268](https://github.com/shanto268) - 230 contributions
- [elizabethkunz](https://github.com/elizabethkunz) - 17 contributions
- [NxtGenLegend](https://github.com/NxtGenLegend) - 1 contributions
---


