laylight 0.0.2__tar.gz → 0.2.2__tar.gz

laylight-0.2.2/.gitignore

@@ -0,0 +1,33 @@
+/target
+node_modules/
+dist/
+packages/laylight-viewer-demo/public/
+
+# large local test fixture (kept out of git; re-obtain or regenerate locally)
+samples/gds/large-test.gds
+samples/gds/large-test.gds.gz
+
+# generated perf-bench fixture (regenerate: cargo run --release -p psdb --example gen_bench_gds)
+samples/gds/bench-gen.gds
+samples/gds/bench-gen.gds.gz
+
+# generated CI perf-gate fixture (regenerated by scripts/perf-gate.mjs)
+samples/gds/bench-gate.gds
+
+# Python workspace (root pyproject.toml, packages under pypkg/)
+__pycache__/
+*.py[oc]
+*.egg-info
+.venv
+.pytest_cache
+.local
+build/
+wheels/
+
+# laylight docs site build output (packages/laylight-docs)
+packages/laylight-docs/.next/
+packages/laylight-docs/out/
+*.tsbuildinfo
+packages/laylight-docs/lib/lyl-samples.generated.ts
+packages/laylight-docs/lib/benchmarks.generated.ts
+packages/laylight-docs/lib/photonics-examples.generated.ts

laylight-0.2.2/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.5
+Name: laylight
+Version: 0.2.2
+Summary: Photonic layout in Python, compiled to GDSII by the Laylight compiler
+Keywords: gds,layout,photonics
+Requires-Python: >=3.10
+Requires-Dist: laylight-cli==0.2.2
+Provides-Extra: klayout
+Requires-Dist: klayout>=0.30.8; extra == 'klayout'
+Description-Content-Type: text/markdown
+
+# laylight
+
+`laylight` is a Python toolkit for photonic layout design. Devices are Python classes; the library builds the [Laylight IR](https://laylight.photonstack.io/concepts/compilation/) from them, and the Laylight compiler, the `laylight` command line, turns the IR into GDSII.
+
+laylight is a sub-product of [PhotonStack](https://photonstack.io/), focused on making photonic design more programmable, composable, and easier to explore.
+
+## Why laylight
+
+Photonic layout work often mixes device geometry, parameter sweeps, custom scripts, and visualization. laylight provides a Python-first way to:
+
+- define photonic structures with reusable, parameterized devices
+- chain devices port to port with `Placer`
+- write layouts that carry their cells' parameters, ports and connections, through the same compiler as the [Laylight DSL](https://laylight.photonstack.io/concepts/dsl/)
+
+## Documentation and tools
+
+- Documentation: [laylight.photonstack.io](https://laylight.photonstack.io/)
+- Playground: [laylight.photonstack.io/playground](https://laylight.photonstack.io/playground/)
+- VS Code extension: [PhotonStack/laylight-vscode-extension](https://github.com/PhotonStack/laylight-vscode-extension)
+
+## Installation
+
+```bash
+pip install laylight
+```
+
+This installs the `laylight` command line too (the `laylight-cli` package). PNG previews and KLayout PCells need KLayout:
+
+```bash
+pip install "laylight[klayout]"
+```
+
+## Simple example
+
+```python
+import laylight
+from laylight.render import new_layout
+from laylight.structure.wg import WGStraight
+
+layout, top, tech = new_layout("DEMO")
+
+device = WGStraight(
+    length=200,
+    width=0.5,
+    layout=layout,
+    tech=tech,
+)
+
+laylight.Placer(device).into(top)
+layout.write("demo.gds")
+```
+
+This creates a straight waveguide and writes the result to `demo.gds`. `layout.to_ir()` returns the Laylight IR, and `layout.write("demo.lyir")` writes it to a file that Laylight DSL code can `import`.
+
+## Learn more
+
+For guided examples, API usage, and browser-based experiments, start with the documentation site and the online playground.

{laylight-0.0.2 → laylight-0.2.2}/README.md

@@ -1,6 +1,6 @@
 # laylight
 
-`laylight` is a Python toolkit for photonic layout design. It helps engineers and researchers describe photonic structures in code, generate layout data with KLayout, and build repeatable design flows around reusable devices.
+`laylight` is a Python toolkit for photonic layout design. Devices are Python classes; the library builds the [Laylight IR](https://laylight.photonstack.io/concepts/compilation/) from them, and the Laylight compiler, the `laylight` command line, turns the IR into GDSII.
 
 laylight is a sub-product of [PhotonStack](https://photonstack.io/), focused on making photonic design more programmable, composable, and easier to explore.
 
@@ -8,9 +8,9 @@ laylight is a sub-product of [PhotonStack](https://photonstack.io/), focused on
 
 Photonic layout work often mixes device geometry, parameter sweeps, custom scripts, and visualization. laylight provides a Python-first way to:
 
-- define photonic structures with reusable building blocks
-- generate layout data with a programmable workflow
-- preview and iterate on designs more quickly than manual editing alone
+- define photonic structures with reusable, parameterized devices
+- chain devices port to port with `Placer`
+- write layouts that carry their cells' parameters, ports and connections, through the same compiler as the [Laylight DSL](https://laylight.photonstack.io/concepts/dsl/)
 
 ## Documentation and tools
 
@@ -24,18 +24,20 @@ Photonic layout work often mixes device geometry, parameter sweeps, custom scrip
 pip install laylight
 ```
 
+This installs the `laylight` command line too (the `laylight-cli` package). PNG previews and KLayout PCells need KLayout:
+
+```bash
+pip install "laylight[klayout]"
+```
+
 ## Simple example
 
 ```python
 import laylight
-
-from laylight.technology import Technology
+from laylight.render import new_layout
 from laylight.structure.wg import WGStraight
 
-layout = laylight.Layout()
-layout.dbu = 0.001
-tech = Technology()
-top = layout.create_cell("DEMO")
+layout, top, tech = new_layout("DEMO")
 
 device = WGStraight(
     length=200,
@@ -48,9 +50,8 @@ laylight.Placer(device).into(top)
 layout.write("demo.gds")
 ```
 
-This creates a simple straight waveguide and writes the result to `demo.gds`.
+This creates a straight waveguide and writes the result to `demo.gds`. `layout.to_ir()` returns the Laylight IR, and `layout.write("demo.lyir")` writes it to a file that Laylight DSL code can `import`.
 
 ## Learn more
 
 For guided examples, API usage, and browser-based experiments, start with the documentation site and the online playground.
-

laylight-0.2.2/laylight/__init__.py

@@ -0,0 +1,64 @@
+"""laylight: describe photonic layouts in Python and compile them with the
+Laylight compiler.
+
+Devices draw into a `Layout` of cells; `Layout.to_ir()` is the Laylight IR
+of the result and `Layout.write("out.gds")` compiles it to GDSII with the
+`laylight` command line.
+"""
+
+from . import structure
+from .backend import CompilerError, CompilerWarning
+from .geometry import Box, Path, Point, Polygon, SimplePolygon, Trans, Vector, text
+from .layout import Cell, CellInstArray, Instance, Layout, Marker, PortRef, read
+from .pcell import (
+    PCellParameterSpec,
+    abstract_device_to_pcell,
+    register_abstract_device_pcell,
+)
+from .placable import Chain, Placer
+from .render import (
+    LayoutRenderError,
+    RenderArtifacts,
+    execute_layout_code,
+    export_layout_png,
+    new_layout,
+    render_code_to_files,
+)
+from .structure.abstract import AbstractDevice, AdhocDevice
+from .technology import LayerInfo, Technology
+
+__all__ = [
+    "AbstractDevice",
+    "AdhocDevice",
+    "Box",
+    "Cell",
+    "CellInstArray",
+    "Chain",
+    "CompilerError",
+    "CompilerWarning",
+    "Instance",
+    "LayerInfo",
+    "Layout",
+    "LayoutRenderError",
+    "Marker",
+    "PCellParameterSpec",
+    "Path",
+    "Placer",
+    "Point",
+    "Polygon",
+    "PortRef",
+    "RenderArtifacts",
+    "SimplePolygon",
+    "Technology",
+    "Trans",
+    "Vector",
+    "abstract_device_to_pcell",
+    "execute_layout_code",
+    "export_layout_png",
+    "new_layout",
+    "read",
+    "register_abstract_device_pcell",
+    "render_code_to_files",
+    "structure",
+    "text",
+]

laylight-0.2.2/laylight/backend.py

@@ -0,0 +1,143 @@
+"""The compiler backend: the `laylight` command line (the `laylight-cli`
+package) turns Laylight IR into GDSII, and reads GDSII back as IR.
+
+The command is found through the `LAYLIGHT_CLI` environment variable, then
+where the installed `laylight-cli` package put it, then next to the running
+Python, then on `PATH`.
+"""
+
+from __future__ import annotations
+
+import functools
+from importlib import metadata
+import os
+from pathlib import Path
+import re
+import shutil
+import subprocess
+import sys
+import sysconfig
+import tempfile
+from typing import Sequence
+import warnings
+
+# The first release whose `build` reads IR.
+MIN_VERSION = (0, 2, 2)
+
+
+class CompilerError(RuntimeError):
+    """The `laylight` command line is missing or failed."""
+
+
+class CompilerWarning(UserWarning):
+    """A warning from the `laylight` command line."""
+
+
+def find_cli() -> str:
+    """The path of the `laylight` command."""
+    configured = os.environ.get("LAYLIGHT_CLI")
+    if configured:
+        if not Path(configured).is_file():
+            raise CompilerError(f"LAYLIGHT_CLI is set to `{configured}`, which is not a file")
+        return configured
+    executable = "laylight.exe" if sys.platform == "win32" else "laylight"
+    for candidate in _installed_scripts(executable):
+        if candidate.is_file():
+            return str(candidate)
+    for directory in (sysconfig.get_path("scripts"), str(Path(sys.executable).parent)):
+        candidate = Path(directory) / executable
+        if candidate.is_file():
+            return str(candidate)
+    found = shutil.which("laylight")
+    if found:
+        return found
+    raise CompilerError(
+        "the `laylight` command line was not found: install it with "
+        "`pip install laylight-cli`, or point LAYLIGHT_CLI at the executable"
+    )
+
+
+def _installed_scripts(executable: str) -> list[Path]:
+    """Where the installed `laylight-cli` distribution put its command: the
+    script its record lists, and `bin/` beside it (`pip install --target`)."""
+    try:
+        dist = metadata.distribution("laylight-cli")
+    except metadata.PackageNotFoundError:
+        return []
+    found = [
+        Path(str(dist.locate_file(f)))
+        for f in dist.files or []
+        if f.name == executable and f.parent.name in ("bin", "Scripts")
+    ]
+    root = Path(str(dist.locate_file("")))
+    found += [root / "bin" / executable, root / "Scripts" / executable]
+    return found
+
+
+@functools.lru_cache(maxsize=None)
+def cli_version(cli: str | None = None) -> tuple[int, ...]:
+    """The version of the `laylight` command, as numbers."""
+    command = cli or find_cli()
+    result = subprocess.run([command, "--version"], capture_output=True, text=True)
+    match = re.search(r"(\d+)\.(\d+)\.(\d+)", result.stdout)
+    if result.returncode != 0 or match is None:
+        raise CompilerError(f"`{command} --version` failed: {result.stderr.strip() or result.stdout.strip()}")
+    return tuple(int(part) for part in match.groups())
+
+
+def run(args: Sequence[str], *, cli: str | None = None) -> subprocess.CompletedProcess[str]:
+    """Runs `laylight <args>` and returns the completed process; a failure
+    raises `CompilerError` with the command's messages."""
+    command = cli or find_cli()
+    version = cli_version(command)
+    if version < MIN_VERSION:
+        needed = ".".join(str(v) for v in MIN_VERSION)
+        found = ".".join(str(v) for v in version)
+        raise CompilerError(
+            f"laylight {found} at `{command}` cannot compile IR; laylight-cli {needed} or later is needed"
+        )
+    result = subprocess.run([command, *args], capture_output=True, text=True)
+    if result.returncode != 0:
+        message = result.stderr.strip() or result.stdout.strip()
+        raise CompilerError(f"laylight {' '.join(args[:1])} failed:\n{message}")
+    for line in result.stderr.splitlines():
+        if line.startswith("warning: "):
+            warnings.warn(line[len("warning: "):], CompilerWarning, stacklevel=3)
+    return result
+
+
+def build(
+    ir_text: str,
+    output: "str | os.PathLike[str]",
+    *,
+    dummy: Sequence[str] = (),
+    cli: str | None = None,
+) -> Path:
+    """Compiles IR text to `output` (GDSII, or IR for `.lyir`), with optional
+    dummy fill rules (`--dummy`)."""
+    target = Path(output).resolve()
+    with tempfile.TemporaryDirectory(prefix="laylight-") as tmp:
+        source = Path(tmp) / "layout.lyir"
+        source.write_text(ir_text, encoding="utf-8")
+        args = ["build", str(source), "-o", str(target)]
+        for rule in dummy:
+            args += ["--dummy", rule]
+        run(args, cli=cli)
+    return target
+
+
+def to_ir(path: "str | os.PathLike[str]", *, cli: str | None = None) -> str:
+    """The IR text of a layout file (GDSII, IR or Laylight source)."""
+    return run(["ir", str(Path(path).resolve())], cli=cli).stdout
+
+
+__all__ = [
+    "CompilerError",
+    "CompilerWarning",
+    "MIN_VERSION",
+    "build",
+    "cli_version",
+    "find_cli",
+    "run",
+    "to_ir",
+]

laylight-0.2.2/laylight/font.py

@@ -0,0 +1,157 @@
+"""The 5x7 pixel font of the `text` primitive, shared with the Laylight DSL
+(`crates/laylight-dsl/src/geom/font.rs`): printable ASCII.
+
+Each glyph lists its pixel rows from the top, `#` for a filled pixel: seven
+rows above the baseline, then optionally two descender rows.
+"""
+
+from __future__ import annotations
+
+# Rows above the baseline (the height of a capital letter).
+CAP_ROWS = 7
+# Horizontal distance between characters, in pixels.
+ADVANCE = 6
+# Vertical distance between lines, in pixels.
+LINE_PITCH = 11
+
+
+def glyph(c: str) -> str | None:
+    index = ord(c) - ord(" ")
+    if 0 <= index < len(GLYPHS):
+        return GLYPHS[index]
+    return None
+
+
+def boxes(glyph: str) -> list[tuple[int, int, int, int]]:
+    """The pixels of a glyph as few rectangles `(column, row, columns, rows)`,
+    `row` counted from the top: horizontal runs, merged with identical runs
+    in the rows below."""
+    open_boxes: list[tuple[int, int, int, int]] = []
+    done: list[tuple[int, int, int, int]] = []
+    for row, pixels in enumerate(glyph.split("/")):
+        row_runs = _runs(pixels)
+        following: list[tuple[int, int, int, int]] = []
+        for column, top, columns, rows in open_boxes:
+            if (column, columns) in row_runs:
+                following.append((column, top, columns, rows + 1))
+            else:
+                done.append((column, top, columns, rows))
+        for column, columns in row_runs:
+            if not any(b[0] == column and b[2] == columns for b in following):
+                following.append((column, row, columns, 1))
+        open_boxes = following
+    done.extend(open_boxes)
+    return done
+
+
+def _runs(pixels: str) -> list[tuple[int, int]]:
+    """`(start, length)` of each run of filled pixels."""
+    out: list[tuple[int, int]] = []
+    start = None
+    for i, p in enumerate(pixels + "."):
+        if p == "#" and start is None:
+            start = i
+        elif p != "#" and start is not None:
+            out.append((start, i - start))
+            start = None
+    return out
+
+
+# Glyphs for U+0020 to U+007E.
+GLYPHS = (
+    "...../...../...../...../...../...../.....",  # space
+    "..#../..#../..#../..#../..#../...../..#..",  # !
+    ".#.#./.#.#./.#.#./...../...../...../.....",  # "
+    ".#.#./.#.#./#####/.#.#./#####/.#.#./.#.#.",  # #
+    "..#../.####/#.#../.###./..#.#/####./..#..",  # $
+    "##.../##..#/...#./..#../.#.../#..##/...##",  # %
+    ".##../#..#./#.#../.#.../#.#.#/#..#./.##.#",  # &
+    "..#../..#../...../...../...../...../.....",  # '
+    "...#./..#../.#.../.#.../.#.../..#../...#.",  # (
+    ".#.../..#../...#./...#./...#./..#../.#...",  # )
+    "...../..#../#.#.#/.###./#.#.#/..#../.....",  # *
+    "...../..#../..#../#####/..#../..#../.....",  # +
+    "...../...../...../...../...../.##../.##../..#../.#...",  # ,
+    "...../...../...../#####/...../...../.....",  # -
+    "...../...../...../...../...../.##../.##..",  # .
+    "...../....#/...#./..#../.#.../#..../.....",  # /
+    ".###./#...#/#..##/#.#.#/##..#/#...#/.###.",  # 0
+    "..#../.##../..#../..#../..#../..#../.###.",  # 1
+    ".###./#...#/....#/...#./..#../.#.../#####",  # 2
+    "#####/...#./..#../...#./....#/#...#/.###.",  # 3
+    "...#./..##./.#.#./#..#./#####/...#./...#.",  # 4
+    "#####/#..../####./....#/....#/#...#/.###.",  # 5
+    "..##./.#.../#..../####./#...#/#...#/.###.",  # 6
+    "#####/....#/...#./..#../.#.../.#.../.#...",  # 7
+    ".###./#...#/#...#/.###./#...#/#...#/.###.",  # 8
+    ".###./#...#/#...#/.####/....#/...#./.##..",  # 9
+    "...../.##../.##../...../...../.##../.##..",  # :
+    "...../.##../.##../...../...../.##../.##../..#../.#...",  # ;
+    "...#./..#../.#.../#..../.#.../..#../...#.",  # <
+    "...../...../#####/...../#####/...../.....",  # =
+    ".#.../..#../...#./....#/...#./..#../.#...",  # >
+    ".###./#...#/....#/...#./..#../...../..#..",  # ?
+    ".###./#...#/....#/.##.#/#.#.#/#.#.#/.###.",  # @
+    ".###./#...#/#...#/#####/#...#/#...#/#...#",  # A
+    "####./#...#/#...#/####./#...#/#...#/####.",  # B
+    ".###./#...#/#..../#..../#..../#...#/.###.",  # C
+    "###../#..#./#...#/#...#/#...#/#..#./###..",  # D
+    "#####/#..../#..../####./#..../#..../#####",  # E
+    "#####/#..../#..../####./#..../#..../#....",  # F
+    ".###./#...#/#..../#.###/#...#/#...#/.####",  # G
+    "#...#/#...#/#...#/#####/#...#/#...#/#...#",  # H
+    ".###./..#../..#../..#../..#../..#../.###.",  # I
+    "..###/...#./...#./...#./...#./#..#./.##..",  # J
+    "#...#/#..#./#.#../##.../#.#../#..#./#...#",  # K
+    "#..../#..../#..../#..../#..../#..../#####",  # L
+    "#...#/##.##/#.#.#/#.#.#/#...#/#...#/#...#",  # M
+    "#...#/#...#/##..#/#.#.#/#..##/#...#/#...#",  # N
+    ".###./#...#/#...#/#...#/#...#/#...#/.###.",  # O
+    "####./#...#/#...#/####./#..../#..../#....",  # P
+    ".###./#...#/#...#/#...#/#.#.#/#..#./.##.#",  # Q
+    "####./#...#/#...#/####./#.#../#..#./#...#",  # R
+    ".####/#..../#..../.###./....#/....#/####.",  # S
+    "#####/..#../..#../..#../..#../..#../..#..",  # T
+    "#...#/#...#/#...#/#...#/#...#/#...#/.###.",  # U
+    "#...#/#...#/#...#/#...#/#...#/.#.#./..#..",  # V
+    "#...#/#...#/#...#/#.#.#/#.#.#/#.#.#/.#.#.",  # W
+    "#...#/#...#/.#.#./..#../.#.#./#...#/#...#",  # X
+    "#...#/#...#/.#.#./..#../..#../..#../..#..",  # Y
+    "#####/....#/...#./..#../.#.../#..../#####",  # Z
+    ".###./.#.../.#.../.#.../.#.../.#.../.###.",  # [
+    "...../#..../.#.../..#../...#./....#/.....",  # backslash
+    ".###./...#./...#./...#./...#./...#./.###.",  # ]
+    "..#../.#.#./#...#/...../...../...../.....",  # ^
+    "...../...../...../...../...../...../#####",  # _
+    ".#.../..#../...../...../...../...../.....",  # `
+    "...../...../.###./....#/.####/#...#/.####",  # a
+    "#..../#..../#.##./##..#/#...#/#...#/####.",  # b
+    "...../...../.###./#..../#..../#...#/.###.",  # c
+    "....#/....#/.##.#/#..##/#...#/#...#/.####",  # d
+    "...../...../.###./#...#/#####/#..../.###.",  # e
+    "..##./.#..#/.#.../###../.#.../.#.../.#...",  # f
+    "...../...../.####/#...#/#...#/#...#/.####/....#/.###.",  # g
+    "#..../#..../#.##./##..#/#...#/#...#/#...#",  # h
+    "..#../...../.##../..#../..#../..#../.###.",  # i
+    "...#./...../..##./...#./...#./...#./...#./#..#./.##..",  # j
+    "#..../#..../#..#./#.#../##.../#.#../#..#.",  # k
+    ".##../..#../..#../..#../..#../..#../.###.",  # l
+    "...../...../##.#./#.#.#/#.#.#/#.#.#/#.#.#",  # m
+    "...../...../#.##./##..#/#...#/#...#/#...#",  # n
+    "...../...../.###./#...#/#...#/#...#/.###.",  # o
+    "...../...../####./#...#/#...#/#...#/####./#..../#....",  # p
+    "...../...../.####/#...#/#...#/#...#/.####/....#/....#",  # q
+    "...../...../#.##./##..#/#..../#..../#....",  # r
+    "...../...../.####/#..../.###./....#/####.",  # s
+    ".#.../.#.../###../.#.../.#.../.#..#/..##.",  # t
+    "...../...../#...#/#...#/#...#/#..##/.##.#",  # u
+    "...../...../#...#/#...#/#...#/.#.#./..#..",  # v
+    "...../...../#...#/#...#/#.#.#/#.#.#/.#.#.",  # w
+    "...../...../#...#/.#.#./..#../.#.#./#...#",  # x
+    "...../...../#...#/#...#/#...#/#...#/.####/....#/.###.",  # y
+    "...../...../#####/...#./..#../.#.../#####",  # z
+    "...#./..#../..#../.#.../..#../..#../...#.",  # {
+    "..#../..#../..#../..#../..#../..#../..#..",  # |
+    ".#.../..#../..#../...#./..#../..#../.#...",  # }
+    "...../...../.#.../#.#.#/...#./...../.....",  # ~
+)