pheon/README.md
Jan Petykiewicz f474e9848c Require PyArrow in the Python package
Keep the arrow extra available for existing requirements. Update wheel checks and install instructions, and verify that integer packing leaves PyArrow unloaded.
2026-11-18 12:36:58 -08:00

1.9 KiB

Pheon

Pheon reads GDSII layouts into Apache Arrow and provides command-line tools for inspecting and comparing layout revisions. It is written in Rust, with Python bindings and a C API.

  • Inspect cells, records, and reference hierarchies.
  • Compare layout objects, with text or JSON reports and Git integration.
  • Read geometry into Arrow, or scan the hierarchy before loading selected cells.

Comparisons ignore timestamps and element order while preserving duplicates and other object details. They compare object fields and coordinates exactly; see the comparison rules for supported normalization and limits.

Try the command-line tools

From a source checkout, install the CLI with Rust 1.88 or newer:

cargo install --path . --locked --bin pheon
pheon dump chip.gds
pheon diff before.gds after.gds
pheon hierarchy chip.gds --format mermaid

diff returns 0 for equality, 1 for differences, and 2 for invalid or incomplete comparisons. Start with the CLI guide, then set up Git integration if you review layouts in a repository.

Read layouts in Python

Python 3.11 or newer is required. From a source checkout:

python -m pip install .

Run Python outside the source checkout to use the installed package:

from pheon import arrow

layout = arrow.read_path("chip.gds")
print(layout.field("lib_name")[0].as_py())

Source installation needs Rust; prebuilt Python wheels bundle the native library. The Python guide covers installation, selected reads, and integer packing. The Arrow reference describes the returned data.

Learn more

Browse the documentation for layer names, native integration, JSON reports, development, and releases. For writing, Pheon provides low-level GDSII record helpers in Rust.

Licensed under GPL-3.0-only.