pheon/README.md

57 lines
1.9 KiB
Markdown
Raw Normal View History

# 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](docs/comparison.md) for supported normalization and limits.
## Try the command-line tools
From a source checkout, install the CLI with Rust 1.88 or newer:
```sh
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](docs/cli.md), then set up
[Git integration](docs/git.md) if you review layouts in a repository.
## Read layouts in Python
Python 3.11 or newer is required. From a source checkout:
```sh
python -m pip install '.[arrow]'
```
Run Python outside the source checkout to use the installed package:
```python
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](docs/python.md) covers installation, selected reads, and integer
packing. The [Arrow reference](docs/arrow-schema.md) describes the returned data.
## Learn more
Browse the [documentation](docs/index.md) 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](LICENSE.md).