API documentation

• kqcircuits.chips
  • kqcircuits.chips.airbridge_crossings
    • AirbridgeCrossings
      • AirbridgeCrossings.build()
  • kqcircuits.chips.airbridge_dc_test
    • AirbridgeDcTest
      • AirbridgeDcTest.build()
  • kqcircuits.chips.chip
    • Chip
      • Chip.LIBRARY_NAME
      • Chip.LIBRARY_DESCRIPTION
      • Chip.LIBRARY_PATH
      • Chip.display_text_impl()
      • Chip.can_create_from_shape_impl()
      • Chip.parameters_from_shape_impl()
      • Chip.transformation_from_shape_impl()
      • Chip.get_launcher_assignments()
      • Chip.produce_junction_tests()
      • Chip.produce_opt_lit_tests()
      • Chip.produce_ground_grid()
      • Chip.produce_ground_on_face_grid()
      • Chip.produce_frame()
      • Chip.merge_layout_layers_on_face()
      • Chip.merge_layout_layers()
      • Chip.produce_structures()
      • Chip.get_box()
      • Chip.get_filter_regions()
      • Chip.insert_filtered_elements()
      • Chip.get_ground_bump_locations()
      • Chip.post_build()
      • Chip.produce_launchers()
      • Chip.produce_n_launchers()
      • Chip.make_grid_locations()
      • Chip.get_ground_tsv_locations()
  • kqcircuits.chips.crossing_twoface
    • CrossingTwoface
      • CrossingTwoface.build()
  • kqcircuits.chips.daisy_woven
    • DaisyWoven
      • DaisyWoven.build()
  • kqcircuits.chips.dc_test
    • DcTest
      • DcTest.build()
  • kqcircuits.chips.demo
    • Demo
      • Demo.build()
      • Demo.produce_qubits()
      • Demo.produce_qubit()
      • Demo.produce_couplers()
      • Demo.produce_coupler()
      • Demo.produce_control_lines()
      • Demo.produce_driveline()
      • Demo.produce_fluxline()
      • Demo.produce_readout_structures()
      • Demo.produce_readout_structure()
      • Demo.produce_probelines()
      • Demo.produce_probeline()
      • Demo.produce_junction_tests()
  • kqcircuits.chips.demo_twoface
    • DemoTwoface
      • DemoTwoface.build()
      • DemoTwoface.produce_qubits()
      • DemoTwoface.produce_qubit()
      • DemoTwoface.produce_couplers()
      • DemoTwoface.produce_coupler()
      • DemoTwoface.produce_control_lines()
      • DemoTwoface.produce_driveline()
      • DemoTwoface.produce_fluxline()
      • DemoTwoface.produce_readout_structures()
      • DemoTwoface.produce_readout_structure()
      • DemoTwoface.produce_probelines()
      • DemoTwoface.produce_probeline()
  • kqcircuits.chips.empty
    • Empty
      • Empty.make_empty_area()
      • Empty.build()
  • kqcircuits.chips.junction_test
    • JunctionTest
      • JunctionTest.build()
  • kqcircuits.chips.junction_test2
    • JunctionTest2
      • JunctionTest2.build()
  • kqcircuits.chips.launchers
    • Launchers
      • Launchers.build()
  • kqcircuits.chips.lithography_test
    • LithographyTest
      • LithographyTest.build()
      • LithographyTest.create_pattern()
  • kqcircuits.chips.lithography_test_twoface
    • LithographyTestTwoface
      • LithographyTestTwoface.create_pattern()
      • LithographyTestTwoface.build()
  • kqcircuits.chips.munch_qubits
    • MunchQubits
      • MunchQubits.build()
      • MunchQubits.produce_qubits()
      • MunchQubits.produce_coupler()
      • MunchQubits.produce_probeline()
      • MunchQubits.produce_drivelines()
      • MunchQubits.produce_readout_resonators()
  • kqcircuits.chips.quality_factor
    • QualityFactor
      • QualityFactor.build()
  • kqcircuits.chips.quality_factor_twoface
    • QualityFactorTwoface
      • QualityFactorTwoface.build()
      • QualityFactorTwoface.produce_resonator()
  • kqcircuits.chips.sample_holder_test
    • SampleHolderTest
      • SampleHolderTest.build()
  • kqcircuits.chips.shaping
    • Shaping
      • Shaping.build()
  • kqcircuits.chips.simple
    • Simple
      • Simple.build()
  • kqcircuits.chips.single_xmons
    • SingleXmons
      • SingleXmons.launchers
      • SingleXmons.qubits_refpoints
      • SingleXmons.build()
  • kqcircuits.chips.stripes
    • Stripes
      • Stripes.build()
  • kqcircuits.chips.tsv_test
    • TsvTest
      • TsvTest.build()
      • TsvTest.create_xsection()
  • kqcircuits.chips.xmons_direct_coupling
    • XMonsDirectCoupling
      • XMonsDirectCoupling.produce_readout_resonator()
      • XMonsDirectCoupling.produce_qubits()
      • XMonsDirectCoupling.build()
  • Module contents
• kqcircuits.elements
  • kqcircuits.elements.airbridges
    • kqcircuits.elements.airbridges.airbridge
      • Airbridge
        • Airbridge.default_type
        • Airbridge.create()
        • Airbridge.transformation_from_shape_impl()
    • kqcircuits.elements.airbridges.airbridge_multi_face
      • AirbridgeMultiFace
        • AirbridgeMultiFace.default_type
        • AirbridgeMultiFace.build()
    • kqcircuits.elements.airbridges.airbridge_rectangular
      • AirbridgeRectangular
        • AirbridgeRectangular.default_type
        • AirbridgeRectangular.build()
    • Module contents
  • kqcircuits.elements.flip_chip_connectors
    • kqcircuits.elements.flip_chip_connectors.flip_chip_connector
      • FlipChipConnector
        • FlipChipConnector.default_type
        • FlipChipConnector.create()
    • kqcircuits.elements.flip_chip_connectors.flip_chip_connector_dc
      • FlipChipConnectorDc
        • FlipChipConnectorDc.build()
    • kqcircuits.elements.flip_chip_connectors.flip_chip_connector_rf
      • FlipChipConnectorRf
        • FlipChipConnectorRf.build()
        • FlipChipConnectorRf.get_sim_ports()
    • Module contents
  • kqcircuits.elements.fluxlines
    • kqcircuits.elements.fluxlines.fluxline
      • Fluxline
        • Fluxline.default_type
        • Fluxline.create()
    • kqcircuits.elements.fluxlines.fluxline_standard
      • FluxlineStandard
        • FluxlineStandard.build()
    • kqcircuits.elements.fluxlines.fluxline_straight
      • FluxlineStraight
        • FluxlineStraight.build()
    • Module contents
  • kqcircuits.elements.markers
    • kqcircuits.elements.markers.marker
      • Marker
        • Marker.default_type
        • Marker.create()
        • Marker.produce_geometry()
        • Marker.get_marker_locations()
        • Marker.get_marker_region()
    • kqcircuits.elements.markers.marker_standard
      • MarkerStandard
        • MarkerStandard.build()
    • kqcircuits.elements.markers.mask_marker_fc
      • MaskMarkerFc
        • MaskMarkerFc.create_cross()
        • MaskMarkerFc.build()
        • MaskMarkerFc.get_marker_locations()
        • MaskMarkerFc.get_marker_region()
    • Module contents
  • kqcircuits.elements.tsvs
    • kqcircuits.elements.tsvs.tsv
      • Tsv
        • Tsv.default_type
        • Tsv.create()
    • kqcircuits.elements.tsvs.tsv_ellipse
      • TsvEllipse
        • TsvEllipse.produce_impl()
        • TsvEllipse.create_tsv_connector()
    • kqcircuits.elements.tsvs.tsv_standard
      • TsvStandard
        • TsvStandard.build()
    • Module contents
  • kqcircuits.elements.airbridge_connection
    • AirbridgeConnection
      • AirbridgeConnection.build()
  • kqcircuits.elements.capacitive_x_coupler
    • CapacitiveXCoupler
      • CapacitiveXCoupler.build()
      • CapacitiveXCoupler.get_sim_ports()
  • kqcircuits.elements.chip_frame
    • ChipFrame
      • ChipFrame.build()
  • kqcircuits.elements.circular_capacitor
    • CircularCapacitor
      • CircularCapacitor.build()
      • CircularCapacitor.get_sim_ports()
  • kqcircuits.elements.element
    • get_refpoints()
    • insert_cell_into()
    • resolve_face()
    • parameter_order_key()
    • Element
      • Element.LIBRARY_NAME
      • Element.LIBRARY_DESCRIPTION
      • Element.LIBRARY_PATH
      • Element.create_cell_from_shape()
      • Element.create()
      • Element.create_subtype()
      • Element.create_with_refpoints()
      • Element.add_element()
      • Element.insert_cell()
      • Element.face()
      • Element.pcell_params_by_name()
      • Element.add_port()
      • Element.copy_port()
      • Element.get_schema()
      • Element.produce_impl()
      • Element.etch_opposite_face_impl()
      • Element.build()
      • Element.post_build()
      • Element.display_text_impl()
      • Element.get_refpoints()
      • Element.get_layer()
      • Element.raise_error_on_cell()
      • Element.add_protection()
      • Element.get_sim_ports()
  • kqcircuits.elements.finger_capacitor_square
    • eval_a2()
    • eval_b2()
    • FingerCapacitorSquare
      • FingerCapacitorSquare.can_create_from_shape_impl()
      • FingerCapacitorSquare.build()
      • FingerCapacitorSquare.get_ground_region()
      • FingerCapacitorSquare.finger_area_width()
      • FingerCapacitorSquare.finger_area_length()
      • FingerCapacitorSquare.cut_region()
      • FingerCapacitorSquare.add_waveguides()
      • FingerCapacitorSquare.get_sim_ports()
  • kqcircuits.elements.finger_capacitor_taper
    • FingerCapacitorTaper
      • FingerCapacitorTaper.can_create_from_shape_impl()
      • FingerCapacitorTaper.build()
  • kqcircuits.elements.hanger_resonator
    • HangerResonator
      • HangerResonator.build()
      • HangerResonator.get_sim_ports()
  • kqcircuits.elements.launcher
    • Launcher
      • Launcher.build()
  • kqcircuits.elements.launcher_dc
    • LauncherDC
      • LauncherDC.build()
  • kqcircuits.elements.meander
    • Meander
      • Meander.can_create_from_shape_impl()
      • Meander.parameters_from_shape_impl()
      • Meander.build()
  • kqcircuits.elements.quarter_wave_cpw_resonator
    • QuarterWaveCpwResonator
      • QuarterWaveCpwResonator.build()
      • QuarterWaveCpwResonator.get_sim_ports()
  • kqcircuits.elements.smooth_capacitor
    • unit_vector()
    • segment_points()
    • SmoothCapacitor
      • SmoothCapacitor.can_create_from_shape_impl()
      • SmoothCapacitor.t_poly()
      • SmoothCapacitor.finger_polygon()
      • SmoothCapacitor.super_smoothen_region()
      • SmoothCapacitor.get_finger_regions()
      • SmoothCapacitor.middle_gap_fill()
      • SmoothCapacitor.insert_wg_joint()
      • SmoothCapacitor.build()
      • SmoothCapacitor.get_sim_ports()
  • kqcircuits.elements.spiral_capacitor
    • SpiralCapacitor
      • SpiralCapacitor.can_create_from_shape_impl()
      • SpiralCapacitor.build()
      • SpiralCapacitor.get_sim_ports()
  • kqcircuits.elements.spiral_resonator_polygon
    • SpiralResonatorPolygon
      • SpiralResonatorPolygon.build()
    • rectangular_parameters()
  • kqcircuits.elements.waveguide_composite
    • Node
      • Node.position
      • Node.element
      • Node.align
      • Node.inst_name
      • Node.angle
      • Node.length_before
      • Node.length_increment
      • Node.meander_direction
      • Node.deserialize()
      • Node.nodes_from_string()
    • WaveguideComposite
      • WaveguideComposite.create()
      • WaveguideComposite.get_segment_cells()
      • WaveguideComposite.get_segment_lengths()
      • WaveguideComposite.produce_fixed_length_waveguide()
      • WaveguideComposite.snap_point()
      • WaveguideComposite.coerce_parameters_impl()
      • WaveguideComposite.build()
      • WaveguideComposite.check_node_type()
    • produce_fixed_length_bend()
  • kqcircuits.elements.waveguide_coplanar
    • WaveguideCoplanar
      • WaveguideCoplanar.can_create_from_shape_impl()
      • WaveguideCoplanar.parameters_from_shape_impl()
      • WaveguideCoplanar.transformation_from_shape_impl()
      • WaveguideCoplanar.produce_waveguide()
      • WaveguideCoplanar.build()
      • WaveguideCoplanar.get_corner_data()
      • WaveguideCoplanar.produce_end_termination()
      • WaveguideCoplanar.is_continuous()
  • kqcircuits.elements.waveguide_coplanar_curved
    • arc()
    • WaveguideCoplanarCurved
      • WaveguideCoplanarCurved.coerce_parameters_impl()
      • WaveguideCoplanarCurved.build_geometry()
      • WaveguideCoplanarCurved.build()
      • WaveguideCoplanarCurved.create_curve_arcs()
      • WaveguideCoplanarCurved.produce_curve_termination()
  • kqcircuits.elements.waveguide_coplanar_splitter
    • WaveguideCoplanarSplitter
      • WaveguideCoplanarSplitter.build()
    • t_cross_parameters()
  • kqcircuits.elements.waveguide_coplanar_straight
    • WaveguideCoplanarStraight
      • WaveguideCoplanarStraight.build_geometry()
      • WaveguideCoplanarStraight.add_waveguide_path()
      • WaveguideCoplanarStraight.build()
  • kqcircuits.elements.waveguide_coplanar_taper
    • WaveguideCoplanarTaper
      • WaveguideCoplanarTaper.build()
  • Module contents
• kqcircuits.junctions
  • kqcircuits.junctions.junction
    • Junction
      • Junction.LIBRARY_NAME
      • Junction.LIBRARY_DESCRIPTION
      • Junction.LIBRARY_PATH
      • Junction.default_type
      • Junction.create()
  • kqcircuits.junctions.manhattan
    • Manhattan
      • Manhattan.build()
      • Manhattan.produce_manhattan_squid()
      • Manhattan.produce_tp_small()
      • Manhattan.produce_tp_large()
      • Manhattan.produce_contact_pads()
  • kqcircuits.junctions.manhattan_single_junction
    • ManhattanSingleJunction
      • ManhattanSingleJunction.build()
      • ManhattanSingleJunction.produce_manhattan_junction()
  • kqcircuits.junctions.no_squid
    • NoSquid
      • NoSquid.build()
  • kqcircuits.junctions.sim
    • Sim
      • Sim.build()
  • kqcircuits.junctions.squid
    • Squid
  • kqcircuits.junctions.super_inductor
    • SuperInductor
      • SuperInductor.build()
      • SuperInductor.produce_super_inductor()
  • 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
    • export_mask_set()
    • export_designs()
    • export_chip()
    • export_masks_of_face()
    • export_mask()
    • export_docs()
    • export_bitmaps()
    • get_mask_layout_full_name()
    • export_junction_parameters()
  • kqcircuits.masks.mask_layout
    • MaskLayout
      • MaskLayout.layout
      • MaskLayout.name
      • MaskLayout.version
      • MaskLayout.with_grid
      • MaskLayout.face_id
      • MaskLayout.layers_to_mask
      • MaskLayout.covered_region_excluded_layers
      • MaskLayout.chips_map
      • MaskLayout.align_to
      • MaskLayout.chips_map_legend
      • MaskLayout.wafer_rad
      • MaskLayout.wafer_center
      • MaskLayout.chips_map_offset
      • MaskLayout.wafer_top_flat_length
      • MaskLayout.wafer_bottom_flat_length
      • MaskLayout.dice_width
      • MaskLayout.text_margin
      • MaskLayout.chip_size
      • MaskLayout.edge_clearance
      • MaskLayout.remove_chips
      • MaskLayout.chip_box_offset
      • MaskLayout.chip_trans
      • MaskLayout.mask_name_offset
      • MaskLayout.mask_name_scale
      • MaskLayout.mask_name_box_margin
      • MaskLayout.mask_text_scale
      • MaskLayout.mask_markers_dict
      • MaskLayout.mask_marker_offset
      • MaskLayout.mask_export_layers
      • MaskLayout.mask_export_density_layers
      • MaskLayout.submasks
      • MaskLayout.extra_id
      • MaskLayout.extra_chips
      • MaskLayout.top_cell
      • MaskLayout.added_chips
      • MaskLayout.chips_placed_by_position_label
      • MaskLayout.chip_copies
      • MaskLayout.mirror_labels
      • MaskLayout.bbox_face_ids
      • MaskLayout.add_chips_map()
      • MaskLayout.build()
      • MaskLayout.insert_chips()
      • MaskLayout.generate_position_label()
      • MaskLayout.generate_and_insert_chip_copy_labels()
      • MaskLayout.insert_chip_copy_labels()
      • MaskLayout.face()
      • MaskLayout.two_coordinates_to_position_label()
      • MaskLayout.position_label_to_two_coordinates()
  • kqcircuits.masks.mask_set
    • MaskSet
      • MaskSet.view
      • MaskSet.layout
      • MaskSet.name
      • MaskSet.version
      • MaskSet.with_grid
      • MaskSet.export_drc
      • MaskSet.chips_map_legend
      • MaskSet.mask_layouts
      • MaskSet.mask_export_layers
      • MaskSet.used_chips
      • MaskSet.export_path
      • MaskSet.add_mask_layout()
      • MaskSet.add_multi_face_mask_layout()
      • MaskSet.add_chip()
      • MaskSet.build()
      • MaskSet.export()
      • MaskSet.chips_map_from_box_map()
  • kqcircuits.masks.multi_face_mask_layout
    • MultiFaceMaskLayout
      • MultiFaceMaskLayout.face_ids
      • MultiFaceMaskLayout.mask_layouts
      • MultiFaceMaskLayout.add_chips_map()
  • Module contents
• kqcircuits.qubits
  • kqcircuits.qubits.circular_transmon_single_island
    • CircularTransmonSingleIsland
      • CircularTransmonSingleIsland.build()
      • CircularTransmonSingleIsland.get_sim_ports()
  • kqcircuits.qubits.concentric_transmon
    • ConcentricTransmon
      • ConcentricTransmon.build()
      • ConcentricTransmon.get_sim_ports()
  • kqcircuits.qubits.double_pads
    • DoublePads
      • DoublePads.build()
      • DoublePads.get_sim_ports()
  • kqcircuits.qubits.double_pads_splines
    • DoublePadsSplines
  • kqcircuits.qubits.qubit
    • Qubit
      • Qubit.LIBRARY_NAME
      • Qubit.LIBRARY_DESCRIPTION
      • Qubit.LIBRARY_PATH
      • Qubit.produce_squid()
      • Qubit.produce_fluxline()
  • kqcircuits.qubits.swissmon
    • Swissmon
      • Swissmon.build()
      • Swissmon.get_sim_ports()
  • Module contents
• kqcircuits.simulations
  • kqcircuits.simulations.epr
    • kqcircuits.simulations.epr.circular_capacitor
      • partition_regions()
      • correction_cuts()
      • extract_circular_capacitor_from()
    • kqcircuits.simulations.epr.circular_transmon_single_island
      • partition_regions()
      • correction_cuts()
    • kqcircuits.simulations.epr.double_pads
      • partition_regions()
      • correction_cuts()
    • kqcircuits.simulations.epr.example
      • partition_regions()
      • correction_cuts()
      • extract_from()
    • kqcircuits.simulations.epr.gui_config
    • kqcircuits.simulations.epr.smooth_capacitor
      • partition_regions()
      • correction_cuts()
    • kqcircuits.simulations.epr.spiral_capacitor
      • partition_regions()
      • correction_cuts()
    • kqcircuits.simulations.epr.swissmon
      • partition_regions()
      • correction_cuts()
      • extract_swissmon_from()
    • kqcircuits.simulations.epr.util
      • in_gui()
      • get_mer_z()
      • extract_child_simulation()
      • create_bulk_and_mer_partition_regions()
  • kqcircuits.simulations.export
    • kqcircuits.simulations.export.ansys
      • kqcircuits.simulations.export.ansys.ansys_export
        • export_ansys_json()
        • export_ansys_bat()
        • export_ansys()
      • kqcircuits.simulations.export.ansys.ansys_solution
        • AnsysSolution
          • AnsysSolution.ansys_tool
          • AnsysSolution.percent_refinement
          • AnsysSolution.maximum_passes
          • AnsysSolution.minimum_passes
          • AnsysSolution.minimum_converged_passes
          • AnsysSolution.frequency_units
          • AnsysSolution.mesh_size
          • AnsysSolution.simulation_flags
          • AnsysSolution.ansys_project_template
          • AnsysSolution.get_solution_data()
        • AnsysHfssTerminalSolution
          • AnsysHfssTerminalSolution.basis_order
          • AnsysHfssTerminalSolution.use_iterative_solver
          • AnsysHfssTerminalSolution.iterative_residual
          • AnsysHfssTerminalSolution.integrate_energies
          • AnsysHfssTerminalSolution.integrate_magnetic_flux
          • AnsysHfssTerminalSolution.get_solution_data()
        • AnsysHfssSolution
          • AnsysHfssSolution.ansys_tool
          • AnsysHfssSolution.frequency
          • AnsysHfssSolution.max_delta_s
          • AnsysHfssSolution.sweep_enabled
          • AnsysHfssSolution.sweep_start
          • AnsysHfssSolution.sweep_end
          • AnsysHfssSolution.sweep_count
          • AnsysHfssSolution.sweep_type
          • AnsysHfssSolution.capacitance_export
          • AnsysHfssSolution.get_solution_data()
        • AnsysQ3dSolution
          • AnsysQ3dSolution.ansys_tool
          • AnsysQ3dSolution.frequency
          • AnsysQ3dSolution.percent_error
          • AnsysQ3dSolution.get_solution_data()
        • AnsysEigenmodeSolution
          • AnsysEigenmodeSolution.ansys_tool
          • AnsysEigenmodeSolution.min_frequency
          • AnsysEigenmodeSolution.max_delta_f
          • AnsysEigenmodeSolution.n_modes
          • AnsysEigenmodeSolution.integrate_energies
          • AnsysEigenmodeSolution.integrate_magnetic_flux
          • AnsysEigenmodeSolution.basis_order
          • AnsysEigenmodeSolution.get_solution_data()
        • AnsysCurrentSolution
          • AnsysCurrentSolution.ansys_tool
          • AnsysCurrentSolution.frequency
          • AnsysCurrentSolution.max_delta_e
          • AnsysCurrentSolution.get_solution_data()
        • AnsysVoltageSolution
          • AnsysVoltageSolution.ansys_tool
          • AnsysVoltageSolution.frequency
          • AnsysVoltageSolution.max_delta_e
          • AnsysVoltageSolution.get_solution_data()
        • AnsysCrossSectionSolution
          • AnsysCrossSectionSolution.ansys_tool
          • AnsysCrossSectionSolution.frequency
          • AnsysCrossSectionSolution.percent_error
          • AnsysCrossSectionSolution.integrate_energies
          • AnsysCrossSectionSolution.get_solution_data()
        • get_ansys_solution()
      • Module contents
    • kqcircuits.simulations.export.cross_section
      • kqcircuits.simulations.export.cross_section.cross_section_export
        • create_cross_sections_from_simulations()
        • visualise_cross_section_cut_on_original_layout()
      • kqcircuits.simulations.export.cross_section.cut_simulation
        • CutSimulation
          • CutSimulation.build()
          • CutSimulation.process_geometry()
          • CutSimulation.limited_region()
          • CutSimulation.insert_cross_section_layers()
          • CutSimulation.insert_sheet_metals()
          • CutSimulation.get_partition_regions()
          • CutSimulation.apply_partition_regions()
          • CutSimulation.regroup_layers()
          • CutSimulation.insert_tls_layers()
          • CutSimulation.get_metals_vacuums_substrates()
          • CutSimulation.sum_region()
          • CutSimulation.subtract_region()
          • CutSimulation.get_material_dict()
          • CutSimulation.get_parameters()
      • kqcircuits.simulations.export.cross_section.epr_correction_export
        • get_epr_correction_elmer_solution()
        • get_epr_correction_simulations()
      • Module contents
    • kqcircuits.simulations.export.elmer
      • kqcircuits.simulations.export.elmer.elmer_export
        • export_elmer_json()
        • export_elmer_script()
        • export_elmer()
      • kqcircuits.simulations.export.elmer.elmer_solution
        • ElmerSolution
          • ElmerSolution.tool
          • ElmerSolution.percent_error
          • ElmerSolution.max_error_scale
          • ElmerSolution.max_outlier_fraction
          • ElmerSolution.maximum_passes
          • ElmerSolution.minimum_passes
          • ElmerSolution.is_axisymmetric
          • ElmerSolution.mesh_levels
          • ElmerSolution.mesh_size
          • ElmerSolution.mesh_optimizer
          • ElmerSolution.vtu_output
          • ElmerSolution.save_elmer_data
          • ElmerSolution.get_solution_data()
        • ElmerVectorHelmholtzSolution
          • ElmerVectorHelmholtzSolution.tool
          • ElmerVectorHelmholtzSolution.frequency
          • ElmerVectorHelmholtzSolution.frequency_batch
          • ElmerVectorHelmholtzSolution.sweep_type
          • ElmerVectorHelmholtzSolution.max_delta_s
          • ElmerVectorHelmholtzSolution.london_penetration_depth
          • ElmerVectorHelmholtzSolution.quadratic_approximation
          • ElmerVectorHelmholtzSolution.second_kind_basis
          • ElmerVectorHelmholtzSolution.use_av
          • ElmerVectorHelmholtzSolution.conductivity
          • ElmerVectorHelmholtzSolution.nested_iteration
          • ElmerVectorHelmholtzSolution.convergence_tolerance
          • ElmerVectorHelmholtzSolution.max_iterations
        • ElmerCapacitanceSolution
          • ElmerCapacitanceSolution.tool
          • ElmerCapacitanceSolution.p_element_order
          • ElmerCapacitanceSolution.linear_system_method
          • ElmerCapacitanceSolution.integrate_energies
          • ElmerCapacitanceSolution.convergence_tolerance
          • ElmerCapacitanceSolution.max_iterations
          • ElmerCapacitanceSolution.linear_system_preconditioning
          • ElmerCapacitanceSolution.electric_infinity_bc
        • ElmerCrossSectionSolution
          • ElmerCrossSectionSolution.tool
          • ElmerCrossSectionSolution.p_element_order
          • ElmerCrossSectionSolution.linear_system_method
          • ElmerCrossSectionSolution.integrate_energies
          • ElmerCrossSectionSolution.boundary_conditions
          • ElmerCrossSectionSolution.convergence_tolerance
          • ElmerCrossSectionSolution.max_iterations
          • ElmerCrossSectionSolution.run_inductance_sim
          • ElmerCrossSectionSolution.linear_system_preconditioning
          • ElmerCrossSectionSolution.voltage_excitations
          • ElmerCrossSectionSolution.electric_infinity_bc
        • ElmerEPR3DSolution
          • ElmerEPR3DSolution.tool
          • ElmerEPR3DSolution.p_element_order
          • ElmerEPR3DSolution.linear_system_method
          • ElmerEPR3DSolution.convergence_tolerance
          • ElmerEPR3DSolution.max_iterations
          • ElmerEPR3DSolution.linear_system_preconditioning
          • ElmerEPR3DSolution.voltage_excitations
          • ElmerEPR3DSolution.electric_infinity_bc
        • get_elmer_solution()
      • kqcircuits.simulations.export.elmer.mesh_size_helpers
        • refine_metal_edges()
      • Module contents
    • kqcircuits.simulations.export.sonnet
      • kqcircuits.simulations.export.sonnet.parser
        • apply_template()
        • polygon_head()
        • symmetry()
        • box()
        • refplane()
        • refplanes()
        • port()
        • control()
        • polygons()
        • via()
      • kqcircuits.simulations.export.sonnet.sonnet_export
        • poly_and_edge_indices()
        • export_sonnet_son()
        • export_sonnet()
      • Module contents
    • kqcircuits.simulations.export.export_and_run
      • export_and_run()
      • run_export_script()
      • run_simulations()
    • kqcircuits.simulations.export.export_singularity
      • export_singularity()
    • kqcircuits.simulations.export.remote_export_and_run
      • remote_export_and_run()
      • remote_run_only()
    • kqcircuits.simulations.export.simulation_export
      • get_combined_parameters()
      • copy_content_into_directory()
      • get_post_process_command_lines()
      • export_simulation_json()
      • export_simulation_oas()
      • sweep_simulation()
      • cross_sweep_simulation()
      • sweep_solution()
      • cross_sweep_solution()
      • cross_combine()
    • kqcircuits.simulations.export.simulation_validate
      • validate_simulation()
      • simulation_and_solution_types_match()
      • has_no_ports_when_required()
      • has_edgeport_when_forbidden()
      • london_penetration_depth_with_ansys()
      • flux_integration_layer_exists_if_needed()
      • check_partition_region_naming()
      • check_tls_sheet_generation()
      • check_tls_sheets_by_solution()
      • recursive_all()
      • get_port_names()
      • ValidateSimError
    • kqcircuits.simulations.export.solution
      • Solution
        • Solution.name
        • Solution.get_parameters()
    • kqcircuits.simulations.export.util
      • find_edge_from_point_in_polygons()
      • get_enclosing_polygon()
    • Module contents
  • kqcircuits.simulations.airbridges_sim
    • AirbridgesSim
      • AirbridgesSim.build()
  • kqcircuits.simulations.cross_section_simulation
    • CrossSectionSimulation
      • CrossSectionSimulation.LIBRARY_NAME
      • CrossSectionSimulation.get_schema()
      • CrossSectionSimulation.get_layers()
      • CrossSectionSimulation.get_parameters()
      • CrossSectionSimulation.is_metal()
      • CrossSectionSimulation.get_material_dict()
      • CrossSectionSimulation.check_material_dict()
      • CrossSectionSimulation.build()
      • CrossSectionSimulation.process_layers()
      • CrossSectionSimulation.insert_layer()
      • CrossSectionSimulation.restrict_layer_regions()
      • CrossSectionSimulation.get_unfilled_region()
      • CrossSectionSimulation.get_simulation_data()
  • kqcircuits.simulations.empty_simulation
    • EmptySimulation
      • EmptySimulation.build()
  • kqcircuits.simulations.partition_region
    • get_list_of_two()
    • PartitionRegion
      • PartitionRegion.limit_box()
      • PartitionRegion.limit_face()
  • kqcircuits.simulations.port
    • Port
      • Port.as_dict()
    • InternalPort
      • InternalPort.get_etch_polygon()
    • EdgePort
  • kqcircuits.simulations.post_process
    • PostProcess
      • PostProcess.get_command_line()
  • kqcircuits.simulations.simulation
    • get_simulation_layer_by_name()
    • to_1d_list()
    • Simulation
      • Simulation.LIBRARY_NAME
      • Simulation.ports
      • Simulation.from_cell()
      • Simulation.build()
      • Simulation.get_schema()
      • Simulation.face()
      • Simulation.insert_cell()
      • Simulation.get_refpoints()
      • Simulation.add_element()
      • Simulation.get_layer()
      • Simulation.pcell_params_by_name()
      • Simulation.face_stack_list_of_lists()
      • Simulation.ith_value()
      • Simulation.face_z_levels()
      • Simulation.region_from_layer()
      • Simulation.simplified_region()
      • Simulation.insert_layer()
      • Simulation.insert_stacked_up_layers()
      • Simulation.insert_layers_between_faces()
      • Simulation.is_metal()
      • Simulation.split_metal_layers_by_excitation()
      • Simulation.create_simulation_layers()
      • Simulation.produce_layers()
      • Simulation.warn_of_small_shapes()
      • Simulation.ground_grid_region()
      • Simulation.produce_waveguide_to_port()
      • Simulation.get_parameters()
      • Simulation.etched_line()
      • Simulation.get_port_data()
      • Simulation.get_material_dict()
      • Simulation.check_material_dict()
      • Simulation.get_simulation_data()
      • Simulation.get_layers()
      • Simulation.get_partition_regions()
      • Simulation.delete_instances()
      • Simulation.visualise_region()
      • Simulation.visualise_ports()
  • kqcircuits.simulations.single_element_simulation
    • get_single_element_sim_class()
  • kqcircuits.simulations.single_xmons_full_chip_sim
    • SingleXmonsFullChipSim
      • SingleXmonsFullChipSim.build()
  • kqcircuits.simulations.waveguides_sim
    • WaveGuidesSim
      • WaveGuidesSim.build()
      • WaveGuidesSim.produce_guides()
      • WaveGuidesSim.produce_ground_bumps()
  • kqcircuits.simulations.xmons_direct_coupling_full_chip_sim
    • XMonsDirectCouplingFullChipSim
      • XMonsDirectCouplingFullChipSim.produce_waveguide()
      • XMonsDirectCouplingFullChipSim.produce_qubit()
      • XMonsDirectCouplingFullChipSim.produce_readout_resonator()
      • XMonsDirectCouplingFullChipSim.produce_launcher()
      • XMonsDirectCouplingFullChipSim.produce_launchers_SMA8()
      • XMonsDirectCouplingFullChipSim.build()
  • kqcircuits.simulations.xmons_direct_coupling_sim
    • XMonsDirectCouplingSim
      • XMonsDirectCouplingSim.produce_qubits()
      • XMonsDirectCouplingSim.build()
  • Module contents
• kqcircuits.test_structures
  • kqcircuits.test_structures.junction_test_pads
    • kqcircuits.test_structures.junction_test_pads.junction_test_pads
      • JunctionTestPads
        • JunctionTestPads.default_type
        • JunctionTestPads.produce_squid()
        • JunctionTestPads.create()
    • kqcircuits.test_structures.junction_test_pads.junction_test_pads_simple
      • JunctionTestPadsSimple
        • JunctionTestPadsSimple.build()
    • Module contents
  • kqcircuits.test_structures.airbridge_dc
    • AirbridgeDC
      • AirbridgeDC.build()
  • kqcircuits.test_structures.cross_test
    • CrossTest
      • CrossTest.build()
  • kqcircuits.test_structures.stripes_test
    • StripesTest
      • StripesTest.build()
  • kqcircuits.test_structures.stripes_test_increasing_width
    • StripesTestIncreasingWidth
      • StripesTestIncreasingWidth.build()
  • kqcircuits.test_structures.test_structure
    • TestStructure
      • TestStructure.LIBRARY_NAME
      • TestStructure.LIBRARY_DESCRIPTION
      • TestStructure.LIBRARY_PATH
      • TestStructure.produce_pad()
      • TestStructure.produce_four_point_pads()
      • TestStructure.produce_etched_region()
  • kqcircuits.test_structures.tsv_test_pattern
    • TsvTestPattern
      • TsvTestPattern.build()
  • Module contents
• kqcircuits.util
  • kqcircuits.util.area
    • AreaReceiver
      • AreaReceiver.put()
    • get_area_and_density()
  • kqcircuits.util.count_instances
    • count_instances_in_cell()
  • kqcircuits.util.coupler_lib
    • cap_params()
  • kqcircuits.util.deep_delete
    • deep_delete_pcells()
    • deep_delete_all()
  • kqcircuits.util.defaults_helper
    • find_ansys_executable()
  • kqcircuits.util.dependencies
    • install_kqc_gui_dependencies()
  • kqcircuits.util.edit_node_plugin
    • EditNodePlugin
    • EditNodePluginFactory
  • kqcircuits.util.error_on_cell
    • find_cells_with_error()
    • formatted_errors_on_cells()
  • kqcircuits.util.export_helper
    • generate_probepoints_json()
    • generate_probepoints_from_file()
    • create_or_empty_tmp_directory()
    • get_simulation_directory()
    • get_active_or_new_layout()
    • write_commit_reference_file()
    • write_export_machine_versions_file()
    • open_with_klayout_or_default_application()
    • get_klayout_version()
    • export_drc_report()
  • kqcircuits.util.geometry_helper
    • vector_length_and_direction()
    • point_shift_along_vector()
    • get_direction()
    • get_angle()
    • get_cell_path_length()
    • get_object_path_length()
    • simple_region()
    • region_with_merged_points()
    • region_with_merged_polygons()
    • merge_points_and_match_on_edges()
    • is_clockwise()
    • circle_polygon()
    • arc_points()
    • bspline_points()
    • bezier_points()
    • force_rounded_corners()
  • kqcircuits.util.geometry_json_encoder
    • GeometryJsonEncoder
      • GeometryJsonEncoder.default()
    • GeometryJsonDecoder
    • encode_python_obj_as_dict()
    • decode_dict_as_python_obj()
  • kqcircuits.util.groundgrid
    • insert_ground_grid()
    • make_ground_grid_region()
  • kqcircuits.util.gui_helper
    • get_nodes_near_position()
    • node_to_text()
    • node_from_text()
    • replace_node()
    • get_all_node_elements()
    • get_valid_node_elements()
  • kqcircuits.util.import_helper
    • module_from_file()
  • kqcircuits.util.instance_hierarchy_helpers
    • InstanceHierarchy
      • InstanceHierarchy.instance
      • InstanceHierarchy.trans
      • InstanceHierarchy.parent_instances
      • InstanceHierarchy.top_cell
    • get_cell_instance_hierarchy()
    • formatted_cell_instance_hierarchy()
    • transform_top_cell()
  • kqcircuits.util.label
    • LabelOrigin
      • LabelOrigin.BOTTOMLEFT
      • LabelOrigin.BOTTOMRIGHT
      • LabelOrigin.TOPLEFT
      • LabelOrigin.TOPRIGHT
    • produce_label()
  • kqcircuits.util.label_polygons
    • get_text_polygon()
    • load_font_polygons()
  • kqcircuits.util.layout_to_code
    • convert_cells_to_code()
    • get_node_params()
    • extract_pcell_data_from_views()
    • restore_pcells_to_views()
  • kqcircuits.util.library_helper
    • load_libraries()
    • get_library_paths()
    • delete_all_libraries()
    • delete_library()
    • element_by_class_name()
    • to_module_name()
    • to_library_name()
  • kqcircuits.util.load_save_layout
    • load_layout()
    • save_layout()
  • kqcircuits.util.log_router
    • route_log()
  • kqcircuits.util.merge
    • merge_layers()
    • merge_layout_layers_on_face()
    • convert_child_instances_to_static()
  • kqcircuits.util.netlist_extraction
    • export_cell_netlist()
    • extract_nets()
    • extract_circuits()
  • kqcircuits.util.netlist_graph
    • network_as_graph()
    • draw_graph()
  • kqcircuits.util.parameters
    • add_parameters_from()
    • add_parameter()
    • pdt
      • pdt.TypeDouble
      • pdt.TypeInt
      • pdt.TypeList
      • pdt.TypeString
      • pdt.TypeShape
      • pdt.TypeBoolean
      • pdt.TypeLayer
      • pdt.TypeNone
    • Param
      • Param.get_all()
  • kqcircuits.util.plugin_startup
    • register_plugins()
  • kqcircuits.util.refpoints
    • Refpoints
      • Refpoints.layer
      • Refpoints.cell
      • Refpoints.trans
      • Refpoints.rec_levels
      • Refpoints.dict()
      • Refpoints.items()
      • Refpoints.keys()
      • Refpoints.values()
    • RefpointToSimPort
      • RefpointToSimPort.refpoint
      • RefpointToSimPort.face
    • RefpointToInternalPort
    • RefpointToEdgePort
    • WaveguideToSimPort
      • WaveguideToSimPort.refpoint
      • WaveguideToSimPort.face
      • WaveguideToSimPort.towards
      • WaveguideToSimPort.side
      • WaveguideToSimPort.use_internal_ports
      • WaveguideToSimPort.waveguide_length
      • WaveguideToSimPort.term1
      • WaveguideToSimPort.turn_radius
      • WaveguideToSimPort.a
      • WaveguideToSimPort.b
      • WaveguideToSimPort.over_etching
      • WaveguideToSimPort.airbridge
      • WaveguideToSimPort.deembed_cross_section
    • JunctionSimPort
      • JunctionSimPort.refpoint
      • JunctionSimPort.other_refpoint
      • JunctionSimPort.face
      • JunctionSimPort.floating
  • kqcircuits.util.replace_junctions
    • JunctionEntry
    • extract_junctions()
    • check_static_cell_has_junctions()
    • place_junctions()
    • get_tuned_junction_json()
    • copy_one_layer_of_cell()
    • replace_squids()
    • replace_squid()
    • convert_cells_to_static()
  • kqcircuits.util.symmetric_polygons
    • polygon_with_hsym()
    • polygon_with_vsym()
    • polygon_with_sym()
  • Module contents

• kqcircuits.defaults
• kqcircuits.klayout_view
  • KLayoutView
    • KLayoutView.layout_view
    • KLayoutView.insert_cell()
    • KLayoutView.focus()
    • KLayoutView.show()
    • KLayoutView.close()
    • KLayoutView.cell_view
    • KLayoutView.layout
    • KLayoutView.active_cell
    • KLayoutView.top_cell
    • KLayoutView.clear_layers()
    • KLayoutView.add_default_layers()
    • KLayoutView.create_top_cell()
    • KLayoutView.export_layers_bitmaps()
    • KLayoutView.export_all_layers_bitmap()
    • KLayoutView.export_pcell_png()
    • KLayoutView.get_pixels()
    • KLayoutView.load_layout()
    • KLayoutView.save_layout()
    • KLayoutView.get_active_cell_view()
    • KLayoutView.get_active_layout()
    • KLayoutView.get_active_cell()
  • MissingUILibraryException
  • resolve_default_layer_info()
• kqcircuits.layer_cluster
  • LayerCluster
    • LayerCluster.main_layers
    • LayerCluster.extra_layers
    • LayerCluster.face_id
    • LayerCluster.all_layers()
• kqcircuits.pya_resolver
  • is_standalone_session()
  • klayout_executable_command()
• kqcircuits.run
  • argument_parser()
  • run_kqc()
  • run()

Module contents