Metadata-Version: 2.1
Name: SQuADDS
Version: 0.2.1
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
Requires-Dist: cython >=0.29.20
Requires-Dist: numpy >=1.16.6
Requires-Dist: scipy >=1.5
Requires-Dist: qutip >=4.3.1
Requires-Dist: addict
Requires-Dist: huggingface-hub
Requires-Dist: pandas
Requires-Dist: python-dotenv
Requires-Dist: scqubits
Requires-Dist: seaborn
Requires-Dist: setuptools
Requires-Dist: tabulate

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

# ![Alpha Version](https://img.shields.io/badge/Status-Alpha%20Version-yellow) Superconducting Qubit And Device Design and Simulation database

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

- [Setup](#setup)
- [Features](#features)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

---

## Setup

Install using pip:

```bash
pip install SQuADDS
```

Install from source:

### Installation

1. Clone the repository.

```bash
git clone https://github.com/LFL-Lab/SQuADDS.git
```

2. Install the required packages.

```bash
pip install -r requirements.txt
```

3. Run the setup script locally

```bash
pip install -e .
```

## 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)
- [(COMING SOON) Tutorial 4: Adding your own Qubit Hamiltonian Calculator]()
- [(COMING SOON) Tutorial 5: Creating your own Interpolater]()
- [(COMING SOON) Tutorial 6: Creating your own Simulator]()

## Contributing

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.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contact

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

---

## Next Release:

### [Version 0.3 Features](next_release.md):

---
