jan/masque
1
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

[tutorial] include a repetition and update docs

Browse source
This commit is contained in:
jan 2026-02-15 20:05:38 -08:00
commit 59e996e680
4 changed files with 56 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

9
examples/tutorial/README.md
View file

@ -18,11 +18,14 @@ Contents
* Design a pattern which is meant to plug into an existing pattern (via `.interface()`)
- [pather](pather.py)
* Use `Pather` to route individual wires and wire bundles
* Use `BasicTool` to generate paths
* Use `BasicTool` to automatically transition between path types
- [renderpather](rendpather.py)
* Use `AutoTool` to generate paths
* Use `AutoTool` to automatically transition between path types
- [renderpather](renderpather.py)
* Use `RenderPather` and `PathTool` to build a layout similar to the one in [pather](pather.py),
but using `Path` shapes instead of `Polygon`s.
- [port_pather](port_pather.py)
* Use `PortPather` and the `.at()` syntax for more concise routing
* Advanced port manipulation and connections
Additionaly, [pcgen](pcgen.py) is a utility module for generating photonic crystal lattices.