GDS layout file reader/writer using Rust and Arrow
  • Rust 92.8%
  • Python 6.8%
  • C 0.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jan Petykiewicz 54aa757678 Validate GDSII record sizes through one fallible path
Route every record read through size validation and report malformed payloads
as parse errors instead of panicking. Apply metadata size constraints through
the Record trait, hide Arrow reader internals, and remove unused wrappers and
scratch code.

Add coverage for direct, skipped, and payload reads, truncated buffers, and
FFI error offsets.
2026-11-16 20:44:48 -08:00
.github/workflows Organize documentation into focused user guides 2026-11-16 16:51:41 -08:00
contrib/git Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
docs Organize documentation into focused user guides 2026-11-16 16:51:41 -08:00
pheon Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
src Validate GDSII record sizes through one fallible path 2026-11-16 20:44:48 -08:00
tests Validate GDSII record sizes through one fallible path 2026-11-16 20:44:48 -08:00
tools Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
.gitignore Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
Cargo.lock Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
Cargo.toml Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -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 Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
README.md Organize documentation into focused user guides 2026-11-16 16:51:41 -08:00
rust-toolchain.toml Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -08:00
setup.py Introduce Pheon GDSII parsing and layout review tools 2026-11-16 16:21:21 -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 '.[arrow]'

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

from pheon import arrow

layout = arrow.read_path("chip.gds")
print(layout.field("cell_names")[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.