Document the text limit, JSON omission counters, and hierarchy options. Use absolute links for the documentation referenced by the README.
65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
# 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][comparison] 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][cli], then set up
|
|
[Git integration][git] 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 .
|
|
```
|
|
|
|
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("lib_name")[0].as_py())
|
|
```
|
|
|
|
Source installation needs Rust; prebuilt Python wheels bundle the native library.
|
|
The [Python guide][python] covers installation, selected reads, and integer
|
|
packing. The [Arrow reference][arrow] describes the returned data.
|
|
|
|
## Learn more
|
|
|
|
Browse the [documentation][docs] 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].
|
|
|
|
[arrow]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/arrow-schema.md
|
|
[cli]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/cli.md
|
|
[comparison]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/comparison.md
|
|
[docs]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/index.md
|
|
[git]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/git.md
|
|
[license]: https://mpxd.net/code/jan/pheon/src/branch/master/LICENSE.md
|
|
[python]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/python.md
|