# KFactory

> Python framework for photonic and electronic chip layout, built on KLayout's C++ geometry engine.

KFactory provides parametric cells with caching, optical and electrical routing, enclosures via Minkowski sums, and schematic-driven design with LVS. Lengths are integer database units (DBU) on `KCell` and float µm on `DKCell`.

## Getting Started

- [Home](<https://gdsfactory.github.io/kfactory/3.5.0/index.md>)
- [Installation](<https://gdsfactory.github.io/kfactory/3.5.0/getting_started/installation/index.md>)
- [KLive Setup](<https://gdsfactory.github.io/kfactory/3.5.0/getting_started/klive_setup/index.md>)
- [Prerequisites](<https://gdsfactory.github.io/kfactory/3.5.0/getting_started/prerequisites/index.md>)
- [5-Minute Quickstart](<https://gdsfactory.github.io/kfactory/3.5.0/getting_started/quickstart/index.md>)

## Concepts

- [DBU vs µm](<https://gdsfactory.github.io/kfactory/3.5.0/concepts/dbu_vs_um/index.md>)
- [Geometry](<https://gdsfactory.github.io/kfactory/3.5.0/concepts/geometry/index.md>)
- [Instances](<https://gdsfactory.github.io/kfactory/3.5.0/concepts/instances/index.md>)
- [KCell](<https://gdsfactory.github.io/kfactory/3.5.0/concepts/kcell/index.md>)
- [KCLayout](<https://gdsfactory.github.io/kfactory/3.5.0/concepts/kclayout/index.md>)
- [Layers](<https://gdsfactory.github.io/kfactory/3.5.0/concepts/layers/index.md>)
- [Ports](<https://gdsfactory.github.io/kfactory/3.5.0/concepts/ports/index.md>)

## Components

- [Bezier](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/factories/bezier/index.md>)
- [Circular](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/factories/circular/index.md>)
- [Euler](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/factories/euler/index.md>)
- [Overview](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/factories/overview/index.md>)
- [Straight](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/factories/straight/index.md>)
- [Taper](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/factories/taper/index.md>)
- [Overview](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/overview/index.md>)
- [PCells](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/pcells/index.md>)
- [Virtual PCells](<https://gdsfactory.github.io/kfactory/3.5.0/components/cells/virtual/index.md>)
- [Cross-Sections](<https://gdsfactory.github.io/kfactory/3.5.0/components/cross_sections/index.md>)
- [KCell Enclosure](<https://gdsfactory.github.io/kfactory/3.5.0/enclosures/kcell_enclosure/index.md>)
- [Layer Enclosure](<https://gdsfactory.github.io/kfactory/3.5.0/enclosures/layer_enclosure/index.md>)

## Routing

- [All-Angle](<https://gdsfactory.github.io/kfactory/3.5.0/routing/all_angle/index.md>)
- [Bundle Routing Tutorial](<https://gdsfactory.github.io/kfactory/3.5.0/routing/bundle/index.md>)
- [Electrical](<https://gdsfactory.github.io/kfactory/3.5.0/routing/electrical/index.md>)
- [Manhattan Primitives](<https://gdsfactory.github.io/kfactory/3.5.0/routing/manhattan/index.md>)
- [Optical](<https://gdsfactory.github.io/kfactory/3.5.0/routing/optical/index.md>)
- [Overview](<https://gdsfactory.github.io/kfactory/3.5.0/routing/overview/index.md>)
- [Path-Length Matching](<https://gdsfactory.github.io/kfactory/3.5.0/routing/path_length/index.md>)

## PDK &amp; Schematics

- [Creating a PDK](<https://gdsfactory.github.io/kfactory/3.5.0/pdk/creating_pdk/index.md>)
- [Technology &amp; Layer Stack](<https://gdsfactory.github.io/kfactory/3.5.0/pdk/technology/index.md>)
- [45° Crossing](<https://gdsfactory.github.io/kfactory/3.5.0/schematics/crossing45/index.md>)
- [Netlist &amp; I/O](<https://gdsfactory.github.io/kfactory/3.5.0/schematics/netlist/index.md>)
- [Overview](<https://gdsfactory.github.io/kfactory/3.5.0/schematics/overview/index.md>)
- [Ports &amp; Pins](<https://gdsfactory.github.io/kfactory/3.5.0/schematics/ports_and_pins/index.md>)

## Utilities &amp; Guides

- [DRC Fixing](<https://gdsfactory.github.io/kfactory/3.5.0/utilities/drc_fix/index.md>)
- [Fill](<https://gdsfactory.github.io/kfactory/3.5.0/utilities/fill/index.md>)
- [Grid Layout](<https://gdsfactory.github.io/kfactory/3.5.0/utilities/grid/index.md>)
- [Packing](<https://gdsfactory.github.io/kfactory/3.5.0/utilities/packing/index.md>)
- [Session Cache](<https://gdsfactory.github.io/kfactory/3.5.0/utilities/session_cache/index.md>)
- [Best Practices](<https://gdsfactory.github.io/kfactory/3.5.0/howto/best_practices/index.md>)
- [Contributing](<https://gdsfactory.github.io/kfactory/3.5.0/howto/contributing/index.md>)
- [FAQ](<https://gdsfactory.github.io/kfactory/3.5.0/howto/faq/index.md>)
- [Common Patterns](<https://gdsfactory.github.io/kfactory/3.5.0/howto/patterns/index.md>)
- [Coming from gdsfactory](<https://gdsfactory.github.io/kfactory/3.5.0/gdsfactory/index.md>)
- [Config Class](<https://gdsfactory.github.io/kfactory/3.5.0/config/index.md>)
- [Migration](<https://gdsfactory.github.io/kfactory/3.5.0/migration/index.md>)

## API Reference

- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>bezier](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/bezier/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>circular](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/circular/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>euler](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/euler/index.md>)
- [cells](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>straight](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/straight/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>taper](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/taper/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>circular](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/virtual/circular/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>euler](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/virtual/euler/index.md>)
- [virtual](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/virtual/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>straight](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cells/virtual/straight/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>checks](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/checks/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>build](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cli/build/index.md>)
- [cli](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cli/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>conf](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/conf/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>cross\_section](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/cross_section/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>decorators](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/decorators/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>enclosure](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/enclosure/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>exceptions](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/exceptions/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>bezier](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/bezier/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>circular](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/circular/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>euler](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/euler/index.md>)
- [factories](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>straight](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/straight/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>taper](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/taper/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>utils](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/utils/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>circular](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/virtual/circular/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>euler](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/virtual/euler/index.md>)
- [virtual](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/virtual/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>straight](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factories/virtual/straight/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>factory\_metadata](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/factory_metadata/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>geometry](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/geometry/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>grid](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/grid/index.md>)
- [kfactory](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>instance](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/instance/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>instance\_group](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/instance_group/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>instance\_pins](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/instance_pins/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>instance\_ports](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/instance_ports/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>instances](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/instances/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>kcell](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/kcell/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>layer](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/layer/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>layout](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/layout/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>merge](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/merge/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>packing](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/packing/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>pin](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/pin/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>pins](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/pins/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>placer](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/placer/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>port](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/port/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>ports](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/ports/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>protocols](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/protocols/index.md>)
- [aa](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/aa/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>optical](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/aa/optical/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>electrical](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/electrical/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>generic](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/generic/index.md>)
- [routing](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>length\_functions](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/length_functions/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>manhattan](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/manhattan/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>optical](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/optical/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>steps](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/steps/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>utils](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/routing/utils/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>schematic](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/schematic/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>serialization](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/serialization/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>session\_cache](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/session_cache/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>settings](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/settings/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>shapes](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/shapes/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>spatial](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/spatial/index.md>)
- [technology](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/technology/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>layer\_map](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/technology/layer_map/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>typings](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/typings/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>utilities](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/utilities/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>difftest](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/utils/difftest/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>fill](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/utils/fill/index.md>)
- [utils](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/utils/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>simplify](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/utils/simplify/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>violations](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/utils/violations/index.md>)
- [widgets](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/widgets/index.md>)
- [\<code class="doc-symbol doc-symbol-nav doc-symbol-module"\>\</code\>interactive](<https://gdsfactory.github.io/kfactory/3.5.0/reference/kfactory/widgets/interactive/index.md>)