Prerequisites
Python
kfactory requires Python 3.10+. Familiarity with Python basics — functions, classes, type hints, and virtual environments — will help you follow the tutorials.
A good starting point: learnpython.org
Python environment
We strongly recommend using a dedicated virtual environment per project. Popular choices:
| Tool | Notes |
|---|---|
| uv | Fast, modern, Rust-backed. Recommended. |
| venv | Built into Python, minimal setup. |
| conda / miniconda | Good when non-Python dependencies are involved. |
KLayout
KLayout is the open-source GDS/OASIS viewer that kfactory
builds on. kfactory uses the klayout Python package internally, but having the desktop
application installed lets you open .gds files and use the kf.show() live preview feature.
Download: klayout.de/build.html
klive (optional)
klive is a KLayout plug-in that streams GDS files directly from Python into the running KLayout window. It is not required to run kfactory, but it makes the interactive design loop much faster.
See KLive Setup for installation instructions.
See Also
| Topic | Where |
|---|---|
| Installing kfactory | Getting Started: Installation |
| KLive streaming setup | Getting Started: KLive Setup |
| 5-minute quickstart | Getting Started: Quickstart |