GDS layout file reader/writer using Rust and Arrow
  • Rust 93.6%
  • Python 6%
  • C 0.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jan Petykiewicz 4aa36a6d65 Separate hierarchy traversal and text report modules
Build structured hierarchy rows and folded paths before rendering ASCII or Mermaid. Move compact and detailed diff writers alongside their text presentation helpers.
2026-11-19 09:29:21 -08:00
.github/workflows Require PyArrow in the Python package 2026-11-18 12:36:58 -08:00
contrib Add a reproducible upstream GDSII corpus check 2026-11-17 16:15:05 -08:00
docs Render layer labels and terminal styles from report roles 2026-11-19 08:44:28 -08:00
pheon Require PyArrow in the Python package 2026-11-18 12:36:58 -08:00
src Separate hierarchy traversal and text report modules 2026-11-19 09:29:21 -08:00
tests Add an opt-in detailed text diff 2026-11-18 23:20:00 -08:00
tools Require PyArrow in the Python package 2026-11-18 12:36:58 -08:00
.gitignore Build Windows wheels locally and document release builds 2026-11-17 15:07:51 -08:00
Cargo.lock Add terminal colors and clarify elided hierarchy branches 2026-11-18 22:58:12 -08:00
Cargo.toml Add terminal colors and clarify elided hierarchy branches 2026-11-18 22:58:12 -08:00
LICENSE.md Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
MANIFEST.in Organize documentation into focused user guides 2026-11-16 16:51:41 -08:00
pyproject.toml Require PyArrow in the Python package 2026-11-18 12:36:58 -08:00
README.md Clarify diff report controls and README links 2026-11-18 12:37:10 -08:00
rust-toolchain.toml Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
setup.py Build Windows wheels locally and document release builds 2026-11-17 15:07:51 -08:00
test.py Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00

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.