Sample Generic Superconducting Quantum RF PDK#

A generic process design kit (PDK) for superconducting quantum RF applications based on gdsfactory.

Examples#

PDK cells in the documentation: showcases available geometries.
qpdk/samples/: contains example layouts and simulations.
notebooks/: contains notebooks demonstrating design and simulation workflows.
gsim example notebooks: electromagnetic simulation examples using Palace and Meep with gdsfactory.

Installation#

We recommend using uv for package management. just is used for project-specific recipes.

Installation for Users#

Install the package with:

uv pip install qpdk

Optional dependencies for the models and simulation tools can be installed with:

uv pip install qpdk[models]

KLayout Technology Installation#

To use the PDK in KLayout (for viewing GDS files with correct layers and technology settings), you should install the technology files:

# For contributors (from the repository root)
just install-tech

# For users (after installing qpdk)
python -m qpdk.install_tech

[!NOTE] After installation, restart KLayout to ensure the new technology appears.

Installation for Contributors#

Clone the repository and install at least the development dependencies:

git clone https://github.com/gdsfactory/quantum-rf-pdk.git
cd quantum-rf-pdk
uv sync --group dev

[!NOTE] Git LFS must be installed to run all tests locally. Some test data files (e.g., CSV files in tests/models/data/) are tracked with Git LFS and will not be properly downloaded without it.

Testing and Building Documentation#

Check out the commands for testing and building documentation with:

just --list