Skip to main content

KFactory 3.0.1

codecov

KFactory is a Python framework for photonic and electronic chip layout, built on KLayout's C++ geometry engine. It provides parametric cells with caching, optical and electrical routing, enclosures via Minkowski sums, and schematic-driven design with LVS.

Key Features

  • Cell caching — the @kf.cell decorator deduplicates identical components automatically
  • Routing — optical and electrical bundle routing, Manhattan primitives, all-angle routing, and path-length matching
  • Cross-sections & enclosures — define waveguide profiles and automatic boolean cladding layers via Minkowski sums
  • Schematics — place-and-connect workflow with netlist extraction and layout-vs-schematic verification
  • Virtual cells — hierarchical logical containers for schematic-driven design
  • Dual coordinate systemsKCell (integer DBU) and DKCell (float µm) work side by side
  • KLayout integration — full access to kdb.Region, kdb.Polygon, DRC, and GDS/OASIS I/O
  • Jupyter & KLive — live preview in KLayout while editing notebooks
  • PDK system — bundle layers, factories, cross-sections, and technology into reusable packages

Getting Started

Installation

KFactory is available on PyPI and requires Python 3.12+.

uv add kfactory

# or with pip
pip install kfactory

Development

just dev

This installs the development environment and sets up pre-commit hooks.

Ecosystem

Package Description
gdsfactory Full-featured chip design framework — KFactory is its layout backend
kfnetlist Standalone netlist extraction and generation

Documentation

Full documentation is available at gdsfactory.github.io/kfactory.

Upgrading from an earlier version? See the migration guide.

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kfactory-3.0.1.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kfactory-3.0.1-py3-none-any.whl (288.5 kB view details)

Uploaded Python 3

File details

Details for the file kfactory-3.0.1.tar.gz.

File metadata

  • Download URL: kfactory-3.0.1.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kfactory-3.0.1.tar.gz
Algorithm Hash digest
SHA256 176f74a2942864d8acb33bacec622c78a7a98ef2e98174dcbd79786c70200ce9
MD5 c775c04492433d604b89837a01922d44
BLAKE2b-256 3851db86a5d8acbea261ab8f7a1a3dc23d132989d0523e758b9a32ab3e8ca0a2

See more details on using hashes here.

File details

Details for the file kfactory-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: kfactory-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 288.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kfactory-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe4bd28fcb0ce49aff9d14f6dc7a4cdd61a04de7985fe7964413583dbdd40e0a
MD5 e8de9bac9399eb819415f3f8844b6eb0
BLAKE2b-256 0b9ae76c513b2ccc823617a9c4707ffd3af91219ecbdb40159a8e6a45408d214

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page