pheon/docs/layer-names.md
Jan Petykiewicz 6e4b371046 Read gzip-compressed GDSII directly in the CLI
Detect gzip headers on every CLI input and decode all members before parsing.
Keep report offsets relative to the decompressed stream and report corrupt
archives as invalid input. Recognize OASIS headers and explain how to provide
GDSII data.

Cover mixed compressed and plain comparisons, corrupt trailers, and layer-name
output from compressed input.
2026-11-17 16:14:53 -08:00

1.8 KiB

Layer names

Attach readable names to numeric GDSII layer/type pairs so Pheon can show a legend in comparison reports. Names are annotations; geometry keeps its numeric layer assignments.

Add or update names

pheon name-layers chip.gds named.gds --cell CHIP --carrier 900/7 \
    --name 1:0:WG --name 2:0:METAL

Choose an existing cell and an otherwise unused (layer, texttype) pair in that cell as the carrier. The carrier must contain no ordinary design objects. The output path must be new; Pheon refuses to overwrite any existing file, including the input.

The output is uncompressed GDSII, including when the input is gzip-compressed.

The command consolidates the legend into that cell. Existing mappings remain unless you override them with --name. It creates no cells or references, and copies other records, timestamps, unknown records, and trailing padding byte for byte. Input and annotation validation finish before the output is created.

Annotation format

A text label whose exact string is PHEON_LAYER_NAMES_V1 identifies a carrier pair in its cell. Every other text label on that pair in the same cell is a mapping of the form:

layer:datatype:name

For example, 1:0:WG names pair (1, 0) as WG. Numbers are unsigned 16-bit decimals. The name must be nonempty UTF-8 and may contain colons; only the first two colons separate fields.

Mappings are collected across the library. Identical duplicates are accepted; conflicting names for the same pair are errors. Recognized annotation labels are excluded from ordinary object comparison. The name mapping compares separately, while unchanged names remain available in the report legend.

Pheon does not currently read LayoutEditor LayerNames metadata, extract layers, or remap geometry. See the CLI guide for layer selection during review.