Repository files navigation

This repository showcases example notebooks for usingKQCircuits.

KQCircuits is a Python library developed by IQM for automating the design of superconducting quantum circuits. It uses theKLayout layout design program API.

The easiest way to try out is to use live notebook with Binder:

For a local install, install the requirements in therequirements.txt manually or with pip:

pip install -r requirements.txt

A Dockerfile is provided (the same is used in Binder).The image may be built with

docker build -f Dockerfile.dev -t kqc-examples.

and run with, for example

docker run -it --rm -p 8888:8888 kqc-examples jupyter notebook --NotebookApp.default_url=/lab/ --ip=0.0.0.0 --port=8888

to get the same view as Binder.

Consider also the providedsingularity image in KQCircuits for HPC applications and best performance. Therequirements.txt is not installed out-of-the-box but can be done as inLocal install.

This code is part of KQCircuits

Copyright (C) 2021-2023 IQM Finland Oy

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General PublicLicense as published by the Free Software Foundation, either version 3 of the License, or (at your option) any laterversion.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the impliedwarranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, seehttps://www.gnu.org/licenses/gpl-3.0.html.

The software distribution should follow IQM trademark policy for open-source softwaremeetiqm.com/developers/osstmpolicy.IQM welcomes contributions to the code. Please see our contribution agreements for individualsmeetiqm.com/developers/clas/individualand organizationsmeetiqm.com/developers/clas/organization.

KQCircuits is a registered trademark of IQM. Please seeIQM open source software trademark policy.