Refresh installation and walkthrough documentation

This commit is contained in:
Jan Petykiewicz 2026-11-19 11:04:20 -08:00
commit 2b5b184dc6

View file

@ -14,10 +14,11 @@ other object details. They compare object fields and coordinates exactly; see th
## Try the command-line tools
From a source checkout, install the CLI with Rust 1.88 or newer:
Install the CLI [from crates.io][crate] with Rust 1.88 or newer.
Use your own GDSII paths in the examples.
```sh
cargo install --path . --locked --bin pheon
cargo install pheon --locked
pheon dump chip.gds
pheon diff before.gds after.gds
pheon hierarchy chip.gds --format mermaid
@ -29,13 +30,13 @@ comparisons. Start with the [CLI guide][cli], then set up
## Read layouts in Python
Python 3.11 or newer is required. From a source checkout:
Install the Python package [from PyPI][pypi] with Python 3.11 or newer.
```sh
python -m pip install .
python -m pip install pheon
```
Run Python outside the source checkout to use the installed package:
Run this example from a directory containing `chip.gds`.
```python
from pheon import arrow
@ -44,9 +45,8 @@ 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.
The Python package installs PyArrow. See the [Python guide][python] for source
installs and selected reads, and the [Arrow reference][arrow] for the returned data.
## Learn more
@ -59,7 +59,9 @@ 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
[crate]: https://crates.io/crates/pheon
[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
[pypi]: https://pypi.org/project/pheon/
[python]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/python.md