pheon/README.md

2.4 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

Install the CLI from crates.io with Rust 1.88 or newer. Use your own GDSII paths in the examples.

cargo install pheon --locked
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

Install the Python package from PyPI with Python 3.11 or newer.

python -m pip install pheon

Run this example from a directory containing chip.gds.

from pheon import arrow

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

The Python package installs PyArrow. See the Python guide for source installs and selected reads, and the Arrow reference for 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.