Installation
KLayout
Known installation issues
Installing different Python package versions to KLayout manually
Getting started (Salt package)
Installing KQCircuits Salt Package
First look around
Setting up a user package directory
Defining a custom element
Defining a custom chip
Upgrading or Removing Salt Package
Release Notes
User Guide
Usage
GUI Features
Useful hotkeys
Introduction to Elements
Placing Elements
Modifying Element parameters
Modifying waveguides
Editing WaveguideComposite Nodes
Converting elements placed in GUI into code
Useful Menu Commands
Point-and-click workflow tutorial
Python workflow tutorial
File system hierarchy
Structure of Element code
Element
class
Libraries
Parameters
Build
Example of defining an
Element
class
Example of defining a Chip and inserting elements into it
Defining sampleholder types
Refpoints
KQCircuit’s Layers
Faces
Layer configuration files
Adding a new face
Opening
Element
or
Chip
from an IDE
Macro development
Running the first example
Interacting with the KLayout application
Creating a new panel
Accessing the currently active panel
Using
KLayoutView
Debugger
Reloading libraries
Examples
Mask export
Tutorial
Basic mask script and export
Ground grid
Adding and modifying chips
Multi-face masks
External simulation tools
Creating simulation object
Geometry from Klayout GUI
Geometry from KQCircuits library
Ansys export
Ansys scripts
Sonnet export
Gmsh/Elmer export
Run and export in one line
General Structure and Miscellaneous Utilities
File system hierarchy
Miscellaneous Utilities
Creating cross section images
KLayout GUI XSection tool
XSection call in KQC code
Process files (.xs)
Terminology
Developer Guide
Developer Setup
Prerequisites
Python
Sources
Install
Update
Secondary install
Manual installation
Linux or MacOS
Windows
KLayout Standalone Usage
Prerequisites
Installation
PyPI Installation
Usage
Jupyter notebook usage
Containers
CLI usage
Docker CI usage
Singularity usage
Architecture
Elements
PCell parameters
Libraries
pya resolver
Testing
Unit tests
Coding Style
Documentation
Contributing
Versioning
API documentation
kqcircuits.chips
kqcircuits.chips.airbridge_crossings
kqcircuits.chips.airbridge_dc_test
kqcircuits.chips.chip
kqcircuits.chips.crossing_twoface
kqcircuits.chips.daisy_woven
kqcircuits.chips.dc_test
kqcircuits.chips.demo
kqcircuits.chips.demo_twoface
kqcircuits.chips.empty
kqcircuits.chips.junction_test
kqcircuits.chips.junction_test2
kqcircuits.chips.launchers
kqcircuits.chips.lithography_test
kqcircuits.chips.lithography_test_twoface
kqcircuits.chips.quality_factor
kqcircuits.chips.quality_factor_twoface
kqcircuits.chips.sample_holder_test
kqcircuits.chips.shaping
kqcircuits.chips.simple
kqcircuits.chips.single_xmons
kqcircuits.chips.stripes
kqcircuits.chips.tsv_test
kqcircuits.chips.xmons_direct_coupling
Module contents
kqcircuits.elements
kqcircuits.elements.airbridges
kqcircuits.elements.airbridges.airbridge
kqcircuits.elements.airbridges.airbridge_multi_face
kqcircuits.elements.airbridges.airbridge_rectangular
Module contents
kqcircuits.elements.flip_chip_connectors
kqcircuits.elements.flip_chip_connectors.flip_chip_connector
kqcircuits.elements.flip_chip_connectors.flip_chip_connector_dc
kqcircuits.elements.flip_chip_connectors.flip_chip_connector_rf
Module contents
kqcircuits.elements.fluxlines
kqcircuits.elements.fluxlines.fluxline
kqcircuits.elements.fluxlines.fluxline_standard
kqcircuits.elements.fluxlines.fluxline_straight
Module contents
kqcircuits.elements.markers
kqcircuits.elements.markers.marker
kqcircuits.elements.markers.marker_standard
Module contents
kqcircuits.elements.tsvs
kqcircuits.elements.tsvs.tsv
kqcircuits.elements.tsvs.tsv_ellipse
kqcircuits.elements.tsvs.tsv_standard
Module contents
kqcircuits.elements.airbridge_connection
kqcircuits.elements.chip_frame
kqcircuits.elements.circular_capacitor
kqcircuits.elements.element
kqcircuits.elements.finger_capacitor_square
kqcircuits.elements.finger_capacitor_taper
kqcircuits.elements.launcher
kqcircuits.elements.launcher_dc
kqcircuits.elements.mask_marker_fc
kqcircuits.elements.meander
kqcircuits.elements.smooth_capacitor
kqcircuits.elements.spiral_resonator_polygon
kqcircuits.elements.waveguide_composite
kqcircuits.elements.waveguide_coplanar
kqcircuits.elements.waveguide_coplanar_curved
kqcircuits.elements.waveguide_coplanar_splitter
kqcircuits.elements.waveguide_coplanar_straight
kqcircuits.elements.waveguide_coplanar_taper
Module contents
kqcircuits.junctions
kqcircuits.junctions.junction
kqcircuits.junctions.manhattan
kqcircuits.junctions.manhattan_single_junction
kqcircuits.junctions.no_squid
kqcircuits.junctions.sim
kqcircuits.junctions.squid
Module contents
kqcircuits.layer_config
kqcircuits.layer_config.default_layer_config
kqcircuits.layer_config.example_layer_config
Module contents
kqcircuits.masks
kqcircuits.masks.mask_export
kqcircuits.masks.mask_layout
kqcircuits.masks.mask_set
Module contents
kqcircuits.qubits
kqcircuits.qubits.double_pads
kqcircuits.qubits.double_pads_splines
kqcircuits.qubits.qubit
kqcircuits.qubits.swissmon
Module contents
kqcircuits.simulations
kqcircuits.simulations.export
kqcircuits.simulations.export.ansys
kqcircuits.simulations.export.elmer
kqcircuits.simulations.export.sonnet
kqcircuits.simulations.export.xsection
kqcircuits.simulations.export.export_and_run
kqcircuits.simulations.export.simulation_export
kqcircuits.simulations.export.util
Module contents
kqcircuits.simulations.airbridges_sim
kqcircuits.simulations.circular_capacitor_sim
kqcircuits.simulations.cross_section_simulation
kqcircuits.simulations.double_pads_sim
kqcircuits.simulations.empty_simulation
kqcircuits.simulations.finger_capacitor_sim
kqcircuits.simulations.flip_chip_connector_sim
kqcircuits.simulations.port
kqcircuits.simulations.simulation
kqcircuits.simulations.single_xmon
kqcircuits.simulations.single_xmons_full_chip_sim
kqcircuits.simulations.waveguides_sim
kqcircuits.simulations.xmons_direct_coupling_full_chip_sim
kqcircuits.simulations.xmons_direct_coupling_sim
Module contents
kqcircuits.test_structures
kqcircuits.test_structures.junction_test_pads
kqcircuits.test_structures.junction_test_pads.junction_test_pads
kqcircuits.test_structures.junction_test_pads.junction_test_pads_simple
Module contents
kqcircuits.test_structures.airbridge_dc
kqcircuits.test_structures.cross_test
kqcircuits.test_structures.stripes_test
kqcircuits.test_structures.test_structure
kqcircuits.test_structures.tsv_test_pattern
Module contents
kqcircuits.util
kqcircuits.util.area
kqcircuits.util.count_instances
kqcircuits.util.coupler_lib
kqcircuits.util.deep_delete
kqcircuits.util.dependencies
kqcircuits.util.edit_node_plugin
kqcircuits.util.export_helper
kqcircuits.util.geometry_helper
kqcircuits.util.geometry_json_encoder
kqcircuits.util.groundgrid
kqcircuits.util.gui_helper
kqcircuits.util.import_helper
kqcircuits.util.label
kqcircuits.util.layout_to_code
kqcircuits.util.library_helper
kqcircuits.util.log_router
kqcircuits.util.merge
kqcircuits.util.netlist_extraction
kqcircuits.util.netlist_graph
kqcircuits.util.parameter_helper
kqcircuits.util.parameters
kqcircuits.util.plugin_startup
kqcircuits.util.refpoints
kqcircuits.util.replace_squids
kqcircuits.util.symmetric_polygons
Module contents
kqcircuits.defaults
kqcircuits.klayout_view
kqcircuits.layer_cluster
kqcircuits.pya_resolver
Module contents
Support
Citing
Trademarks
About
KQCircuits
»
User Guide
Edit on GitHub
User Guide
¶
Usage
GUI Features
Useful hotkeys
Introduction to Elements
Placing Elements
Modifying Element parameters
Modifying waveguides
Editing WaveguideComposite Nodes
Converting elements placed in GUI into code
Useful Menu Commands
Point-and-click workflow tutorial
Python workflow tutorial
File system hierarchy
Structure of Element code
Element
class
Libraries
Parameters
Build
Example of defining an
Element
class
Example of defining a Chip and inserting elements into it
Defining sampleholder types
Refpoints
KQCircuit’s Layers
Faces
Layer configuration files
Adding a new face
Opening
Element
or
Chip
from an IDE
Macro development
Running the first example
Interacting with the KLayout application
Creating a new panel
Accessing the currently active panel
Using
KLayoutView
Debugger
Reloading libraries
Examples
Mask export
Tutorial
Basic mask script and export
Ground grid
Adding and modifying chips
Multi-face masks
External simulation tools
Creating simulation object
Geometry from Klayout GUI
Geometry from KQCircuits library
Ansys export
Ansys scripts
Main scripts:
Optional scripts:
pyEPR
Sonnet export
Gmsh/Elmer export
Run and export in one line
General Structure and Miscellaneous Utilities
File system hierarchy
Miscellaneous Utilities
Creating cross section images
KLayout GUI XSection tool
XSection call in KQC code
Process files (.xs)
Terminology