README.md

---
license: mit
configs:
- config_name: layout-manifest
  data_files:
  - split: train
    path: "metadata/manifest.parquet"
- config_name: geometry-features-v1
  data_files:
  - split: train
    path: "metadata/geometry-features-v1.parquet"
tags:
- quantum
- superconducting
- qiskit-metal
- qiskit
- gds
- layout
- quantum-hardware
- design
- device
- geometry
pretty_name: SQuADDS Layouts
size_categories:
- 1K<n<10K
---

<center>
  <img src="https://github.com/LFL-Lab/SQuADDS/blob/master/docs/_static/images/squadds_logo_dark_name.png?raw=true" width="80%" alt="SQuADDS Logo" />
</center>

# SQuADDS Layouts - versioned GDS artifacts for superconducting quantum hardware

SQuADDS Layouts is the geometry-artifact companion to
[SQuADDS_DB](https://huggingface.co/datasets/SQuADDS/SQuADDS_DB), the
Superconducting Qubit And Device Design and Simulation Database. It provides
checksum-verified GDS files, stable geometry identities, and machine-readable
geometry metadata so a simulation result can be traced to the exact layout
that produced it.

- **Homepage:** [https://lfl-lab.github.io/SQuADDS/](https://lfl-lab.github.io/SQuADDS/)
- **Repository:** [https://github.com/LFL-Lab/SQuADDS](https://github.com/LFL-Lab/SQuADDS)
- **Simulation database:** [SQuADDS/SQuADDS_DB](https://huggingface.co/datasets/SQuADDS/SQuADDS_DB)
- **Paper:** [https://arxiv.org/pdf/2312.13483.pdf](https://arxiv.org/pdf/2312.13483.pdf)
- **Point of contact:** [Sadman Ahmed Shanto](mailto:shanto@usc.edu)

## Contents

The current release contains 4,577 two-terminal coupler layouts.

| Component | Count | Source simulation configuration | Layout provenance |
| --- | ---: | --- | --- |
| `GeneralizedCapNInterdigital` | 3,683 | `coupler-GeneralizedCapNInterdigital-cap_matrix` | Simulation layouts matched by `notes.source_id` |
| `CapNInterdigitalTee` | 894 | `coupler-CapNInterdigitalTee-cap_matrix` | Deterministic Qiskit Metal exports, one per database row |

Seven supplied generalized-capacitor GDS files without matching simulation rows
are intentionally excluded. The generalized dataset uses `north` and `south`
as canonical terminal names; `top` and `bottom` simulation fields are retained
in SQuADDS_DB as compatibility aliases.

## Dataset Configurations

### `layout-manifest`

`metadata/manifest.parquet` is the authoritative index. Every record includes:

- `layout_id`: content-derived geometry identity.
- `artifact_id`: SHA-256 checksum of the exact GDS file.
- `design_id`: component-aware identity derived from design options.
- `source_id`, `simulation_repo`, and `simulation_config`: links to the source simulation record.
- `gds_path`: repository-relative raw artifact path.
- `bbox_um`, `layers`, `polygon_count`, and `cell_count`: geometry metadata in micrometers.

### `geometry-features-v1`

`metadata/geometry-features-v1.parquet` contains stable numerical features
derived from the manifest without changing the raw GDS artifact. It includes
bounds, area, aspect ratio, polygon and cell counts, plus sparse per-layer
area and polygon statistics. This configuration is the reproducible input
contract for future embedding models; it is not itself a learned embedding.

## Access

Use the SQuADDS Python API to resolve a layout from a SQuADDS_DB row, download
the checksum-verified GDS file, and inspect it on demand:

```python
from squadds import SQuADDS_DB

row = ...  # one SQuADDS_DB simulation row
gds_path = SQuADDS_DB.download_gds(row)
```

Or use `LayoutClient` directly when you have a layout, design, or source ID:

```python
from squadds.layouts import LayoutClient

client = LayoutClient()
layout = client.find(source_id="exp6/cap_0000")
summary = client.summary(layout)
```

Raw artifacts are organized as:

```text
raw/GeneralizedCapNInterdigital/<campaign>/<instance>.gds
raw/CapNInterdigitalTee/generated_from_cap_matrix/<instance>.gds
```

The generalized layer and port convention is documented in
`metadata/layer-semantics-v1.json`. Install the SQuADDS optional GDS dependency
group (`uv sync --extra gds`) to inspect geometry locally.

## Provenance and Contributions

The generalized-capacitor simulation data was contributed by **Saikat Das** of
the Levenson-Falk Lab at USC. `CapNInterdigitalTee` artifacts are reproducibly
generated from their paired SQuADDS_DB design definitions using Qiskit Metal.

New layouts should include a matching SQuADDS_DB simulation row, a stable
source identifier, exact artifact checksum, component name, geometry metadata,
and documented layer semantics. This keeps raw geometry, simulations, derived
features, and future embeddings independently versioned but linkable.

## Citation

If you use SQuADDS Layouts in your research, cite SQuADDS:

```bibtex
@article{Shanto2024squaddsvalidated,
  doi = {10.22331/q-2024-09-09-1465},
  url = {https://doi.org/10.22331/q-2024-09-09-1465},
  title = {{SQ}u{ADDS}: {A} validated design database and simulation workflow for superconducting qubit design},
  author = {Shanto, Sadman and Kuo, Andre and Miyamoto, Clark and Zhang, Haimeng and Maurya, Vivek and Vlachos, Evangelos and Hecht, Malida and Shum, Chung Wa and Levenson-Falk, Eli},
  journal = {{Quantum}},
  volume = {8},
  pages = {1465},
  year = {2024}
}
```

## License

This project is licensed under the [MIT License](https://github.com/LFL-Lab/SQuADDS/blob/master/LICENSE).