playdough
GDSFactory's next-gen routing engine — robust, collision-aware Manhattan routing with optional gradient-based finetuning for photonic IC design.
Features
- Search-based Manhattan routing — performant, collision-aware, instant results
- Gradient-based finetuning — flexible constraint satisfaction (path length matching, collision avoidance) via automatic differentiation
- Multi-bundle routing — grouped port bundles with independent tangent directions
- Polyline output — get corner-point coordinates as numpy arrays, with optional smooth euler-bend curves
Installation
pip install playdough
Quick Start
import gdsfactory as gf
import playdough as pld
c = gf.Component()
waveguides = gf.components.array(gf.c.straight, columns=1, rows=3, row_pitch=3)
left = c << waveguides
right = c << waveguides
right.move((100, 50))
obs = c << gf.components.rectangle(size=(80, 10))
obs.ymin = 20
router = pld.add_route_bundle(
c,
start_ports=list(left.ports.filter(orientation=0)),
end_ports=list(right.ports.filter(orientation=180)),
obstacles=[obs],
)
# Optionally finetune for length matching
router.finetune(length_matching=5.0, lr=0.5)
Documentation
See the documentation site for tutorials and API reference.
License
Requires a valid GDSFactory account. Authenticate with gfp configure.
1 maintainer
Metadata
1 maintainer
Release files for playdough 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| playdough-0.5.0-cp312-cp312-win_amd64.whl | CPython 3.12 | CPython 3.12 | Windows x86-64 | Details |
| playdough-0.5.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64 | Details |
| playdough-0.5.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.17+ ARM64, Linux glibc 2.28+ ARM64 | Details |
| playdough-0.5.0-cp312-cp312-macosx_11_0_arm64.whl | CPython 3.12 | CPython 3.12 | macOS 11.0+ ARM64 | Details |
Total release size: 16.8 MB
Release files / playdough-0.5.0-cp312-cp312-win_amd64.whl
| Download URL | playdough-0.5.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 1.1 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
a15356b4a946add0bb495f681f1fa2d1ddcbe940b28bad2c0f743ef9d0c4dc24
|
|
BLAKE2b-256 checksum How to use checksums |
05c0d61c133e7504c5dc1387ed65a7351b4e2b38ffe7aacb352373399876cfda
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 16, 2026.
Transparency logRelease files / playdough-0.5.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
| Download URL | playdough-0.5.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 7.4 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
93240dde287102052e017a7a447beea87e1c7e4d0127074939d19c5fd5a3d69e
|
|
BLAKE2b-256 checksum How to use checksums |
d6e8bda72f9bcfa1af346b8007715452e3d7945796870ec4712f0d2e05aff20b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 16, 2026.
Transparency logRelease files / playdough-0.5.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl
| Download URL | playdough-0.5.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ ARM64 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
83078730d1c6917039e67acbaee08f0abcc5ae2c1bcbb06c2052bf28618f2b79
|
|
BLAKE2b-256 checksum How to use checksums |
9d68d99afe448e9e4b1f648796dea2a9232e94b9932926fcb73611946cdaf528
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 16, 2026.
Transparency logRelease files / playdough-0.5.0-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | playdough-0.5.0-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
1f9acc33210efd6b5fe052cc6c868f35060cef727493b7572a62485409899f70
|
|
BLAKE2b-256 checksum How to use checksums |
5a2f675d4af48e88bb1c775ac9c0a1ad47f1574d269787807edc5009ccefdf3b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 16, 2026.
Transparency log
