KLayout API implementation of gdsfactory
Project description
KFactory 2.4.1
Kfactory is the backend for gdsfactory. It is built upon KLayout. It offers basic operations like gdsfactory, so it can be used on its own as as layout tool as well.
It is recommended to pin the version of KFactory in requirements.txt or pyproject.toml with kfactory==2.4.1 for example.
Features similar to gdsfactory:
- Cells & decorator for caching & storing cells
- Simple routing (point to point and simpl bundle routes for electrical routes)
- Basic cells like euler/circular bends, taper, waveguide
- Path extrusion (no interface with CrossSections)
- Jupyter integration
- PDK/package configuration
- Plugin system (simulations etc.) - Check kplugins
- Generic PDK example - Check kgeneric
- CrossSection
- Netlist/Schematics and LVS
Notable missing Features:
- More advanced routing
New/Improved Features:
- Fully hierarchical bi-directional conversion to YAML
- Automatic snapping to grid thanks to KLayout
- More features for vector geometries due to concept of Point/Edge/Vector/Polygon from Klayout
- Easy booleans thanks to KLayout Regions
- Enclosures: use the concept of enclosures, similar to cross sections, to allow automatic calculation of boolean layers for structures based on minkowski sum, which are built into KLayout
Getting Started
Installation
kfactory is available as kfactory on PyPI
Install kfactory with uv, or pip:
# Add kfactory to your project.
uv add kfactory
# With pip.
pip install kfactory
At the moment kfactory works only on python 3.11 and above
Development Installation
A development environment can be installed with
just dev
For committing pre-commit should be installed with pre-commit install (this is done with just dev).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kfactory-2.4.1.tar.gz.
File metadata
- Download URL: kfactory-2.4.1.tar.gz
- Upload date:
- Size: 13.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
741cb999f1b38a45a0da01cca5fbd4e771e2e15325cca0e675d6c1598062c48c
|
|
| MD5 |
f1b831cf4be2448f7ee31d38de8fbf7b
|
|
| BLAKE2b-256 |
4294061a0e8085113a9cf1a2d11f76841e65bb32bd4823786675ca1ed01a3338
|
File details
Details for the file kfactory-2.4.1-py3-none-any.whl.
File metadata
- Download URL: kfactory-2.4.1-py3-none-any.whl
- Upload date:
- Size: 252.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a34356e007c0d6f1a526354a5fb0b545affe027de46dab6248365f90db46fa2c
|
|
| MD5 |
437ec59e4b8146505e44d15b0a5e597a
|
|
| BLAKE2b-256 |
cbf34c6064b0335bc028da0026b49b72c327b8a030e044cdfe64f2970031c7ab
|
