[Builder / RenderPather] BREAKING remove aliases to old names

examples/tutorial/README.md

@@ -17,7 +17,7 @@ Contents
     * Build hierarchical photonic-crystal example devices
     * Reference other patterns
     * Add ports to a pattern
-    * Use `Builder` to snap ports together into a circuit
+    * Use `Pather` to snap ports together into a circuit
     * Check for dangling references
 - [library](library.py)
     * Continue from `devices.py` using a lazy library
@@ -29,7 +29,7 @@ Contents
     * 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),
+    * Use `Pather(auto_render=False)` 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

examples/tutorial/devices.py

@@ -1,5 +1,5 @@
 """
-Tutorial: building hierarchical devices with `Pattern`, `Port`, and `Builder`.
+Tutorial: building hierarchical devices with `Pattern`, `Port`, and `Pather`.
 
 This file uses photonic-crystal components as the concrete example, so some of
 the geometry-generation code is domain-specific. The tutorial value is in the
@@ -12,7 +12,7 @@ import numpy
 from numpy import pi
 
 from masque import (
-    layer_t, Pattern, Ref, Builder, Port, Polygon,
+    layer_t, Pattern, Ref, Pather, Port, Polygon,
     Library,
     )
 from masque.utils import ports2data
@@ -261,8 +261,8 @@ def main(interactive: bool = True) -> None:
     #
     # Build a circuit
     #
-    # Create a `Builder`, and register the resulting top cell as "my_circuit".
-    circ = Builder(library=lib, name='my_circuit')
+    # Create a `Pather`, and register the resulting top cell as "my_circuit".
+    circ = Pather(library=lib, name='my_circuit')
 
     # Start by placing a waveguide and renaming its ports to match the circuit-level
     # names we want to use while assembling the design.
@@ -278,7 +278,7 @@ def main(interactive: bool = True) -> None:
     #   lib['my_circuit'] = circ_pat
     #   circ_pat.place(lib.abstract('wg10'), ...)
     #   circ_pat.plug(lib.abstract('wg10'), ...)
-    # but `Builder` removes some repeated `lib.abstract(...)` boilerplate and keeps
+    # but `Pather` removes some repeated `lib.abstract(...)` boilerplate and keeps
     # the assembly code focused on port-level intent.
 
     # Attach a y-splitter to the signal path.

examples/tutorial/library.py

@@ -1,5 +1,5 @@
 """
-Tutorial: using `LazyLibrary` and `Builder.interface()`.
+Tutorial: using `LazyLibrary` and `Pather.interface()`.
 
 This example assumes you have already read `devices.py` and generated the
 `circuit.gds` file it writes. The goal here is not the photonic-crystal geometry
@@ -10,7 +10,7 @@ from typing import Any
 from pprint import pformat
 
 
-from masque import Builder, LazyLibrary
+from masque import Pather, LazyLibrary
 from masque.file.gdsii import writefile, load_libraryfile
 
 import basic_shapes
@@ -64,10 +64,10 @@ def main() -> None:
 
     # Start a new design by copying the ports from an existing library cell.
     # This gives `circ2` the same external interface as `tri_l3cav`.
-    circ2 = Builder(library=lib, ports='tri_l3cav')
+    circ2 = Pather(library=lib, ports='tri_l3cav')
 
     # First way to specify what we are plugging in: request an explicit abstract.
-    # This works with `Pattern` methods directly as well as with `Builder`.
+    # This works with `Pattern` methods directly as well as with `Pather`.
     circ2.plug(lib.abstract('wg10'), {'input': 'right'})
 
     # Second way: use an `AbstractView`, which behaves like a mapping of names
@@ -75,7 +75,7 @@ def main() -> None:
     abstracts = lib.abstract_view()
     circ2.plug(abstracts['wg10'], {'output': 'left'})
 
-    # Third way: let `Builder` resolve a pattern name through its own library.
+    # Third way: let `Pather` resolve a pattern name through its own library.
     # This shorthand is convenient, but it is specific to helpers that already
     # carry a library reference.
     circ2.plug('tri_wg10', {'input': 'right'})
@@ -89,10 +89,10 @@ def main() -> None:
     # Build a second device that is explicitly designed to mate with `circ2`.
     #
 
-    # `Builder.interface()` makes a new pattern whose ports mirror an existing
+    # `Pather.interface()` makes a new pattern whose ports mirror an existing
     # design's external interface. That is useful when you want to design an
     # adapter, continuation, or mating structure.
-    circ3 = Builder.interface(source=circ2)
+    circ3 = Pather.interface(source=circ2)
 
     # Continue routing outward from those inherited ports.
     circ3.plug('tri_bend0', {'input': 'right'})

examples/tutorial/pather.py

@@ -204,9 +204,9 @@ def prepare_tools() -> tuple[Library, Tool, Tool]:
 #
 # Now we can start building up our library (collection of static cells) and pathing tools.
 #
-#   If any of the operations below are confusing, you can cross-reference against the `RenderPather`
-# tutorial, which handles some things more explicitly (e.g. via placement) and simplifies others
-# (e.g. geometry definition).
+#   If any of the operations below are confusing, you can cross-reference against the deferred
+# `Pather` tutorial, which handles some things more explicitly (e.g. via placement) and simplifies
+# others (e.g. geometry definition).
 #
 def main() -> None:
     library, M1_tool, M2_tool = prepare_tools()

examples/tutorial/port_pather.py

@@ -1,7 +1,7 @@
 """
 PortPather tutorial: Using .at() syntax
 """
-from masque import RenderPather, Pattern, Port, R90
+from masque import Pather, Pattern, Port, R90
 from masque.file.gdsii import writefile
 
 from basic_shapes import GDS_OPTS
@@ -12,8 +12,8 @@ def main() -> None:
     # Reuse the same patterns (pads, bends, vias) and tools as in pather.py
     library, M1_tool, M2_tool = prepare_tools()
 
-    # Create a RenderPather and place some initial pads (same as Pather tutorial)
-    rpather = RenderPather(library, tools=M2_tool)
+    # Create a deferred Pather and place some initial pads (same as Pather tutorial)
+    rpather = Pather(library, tools=M2_tool, auto_render=False)
 
     rpather.place('pad', offset=(18_000, 30_000), port_map={'wire_port': 'VCC'})
     rpather.place('pad', offset=(18_000, 60_000), port_map={'wire_port': 'GND'})
@@ -156,7 +156,7 @@ def main() -> None:
     #
     # Rendering and Saving
     #
-    # Since we used RenderPather, we must call .render() to generate the geometry.
+    # Since we deferred auto-rendering, we must call .render() to generate the geometry.
     rpather.render()
 
     library['PortPather_Tutorial'] = rpather.pattern

examples/tutorial/renderpather.py

@@ -1,7 +1,7 @@
 """
-Manual wire routing tutorial: RenderPather an PathTool
+Manual wire routing tutorial: deferred Pather and PathTool
 """
-from masque import RenderPather, Library
+from masque import Pather, Library
 from masque.builder.tools import PathTool
 from masque.file.gdsii import writefile
 
@@ -11,9 +11,9 @@ from pather import M1_WIDTH, V1_WIDTH, M2_WIDTH, map_layer, make_pad, make_via
 
 def main() -> None:
     #
-    #   To illustrate the advantages of using `RenderPather`, we use `PathTool` instead
+    #   To illustrate deferred routing with `Pather`, we use `PathTool` instead
     # of `AutoTool`. `PathTool` lacks some sophistication (e.g. no automatic transitions)
-    # but when used with `RenderPather`, it can consolidate multiple routing steps into
+    # but when used with `Pather(auto_render=False)`, it can consolidate multiple routing steps into
     # a single `Path` shape.
     #
     #   We'll try to nearly replicate the layout from the `Pather` tutorial; see `pather.py`
@@ -39,7 +39,7 @@ def main() -> None:
     # and what port type to present.
     M1_ptool = PathTool(layer='M1', width=M1_WIDTH, ptype='m1wire')
     M2_ptool = PathTool(layer='M2', width=M2_WIDTH, ptype='m2wire')
-    rpather = RenderPather(tools=M2_ptool, library=library)
+    rpather = Pather(tools=M2_ptool, library=library, auto_render=False)
 
     # As in the pather tutorial, we make some pads and labels...
     rpather.place('pad', offset=(18_000, 30_000), port_map={'wire_port': 'VCC'})
@@ -85,7 +85,7 @@ def main() -> None:
 
     # Render the path we defined
     rpather.render()
-    library['RenderPather_and_PathTool'] = rpather.pattern
+    library['Deferred_Pather_and_PathTool'] = rpather.pattern
 
 
     # Convert from text-based layers to numeric layers for GDS, and output the file