Refresh installation and walkthrough documentation
This commit is contained in:
parent
623de2e585
commit
2b5b184dc6
1 changed files with 94 additions and 97 deletions
|
|
@ -1,22 +1,24 @@
|
|||
# Python
|
||||
|
||||
Use `pheon.arrow` to load GDSII geometry into PyArrow, scan a hierarchy, or read
|
||||
only selected cells. The base `pheon` package also provides integer packing.
|
||||
only selected cells. The package also provides integer packing.
|
||||
Python 3.11 or newer is required.
|
||||
|
||||
## Install
|
||||
|
||||
To install a PyPI release:
|
||||
Install Pheon from [PyPI](https://pypi.org/project/pheon/).
|
||||
|
||||
```sh
|
||||
python -m pip install pheon
|
||||
```
|
||||
|
||||
The package installs PyArrow for layout reads. Existing `pheon[arrow]`
|
||||
requirements still work. Prebuilt wheels bundle the native library. From a
|
||||
source checkout, use `python -m pip install .` with Rust 1.88 or newer.
|
||||
requirements still work. [Prebuilt wheels](https://pypi.org/project/pheon/#files)
|
||||
bundle the native library. On platforms without a compatible wheel, pip builds
|
||||
the library from source and needs Rust 1.88 or newer and a native linker.
|
||||
|
||||
Run Python outside the source checkout to use the installed package.
|
||||
From a source checkout, install with `python -m pip install .`, then run Python
|
||||
outside the checkout to import the installed package.
|
||||
|
||||
## Read a layout
|
||||
|
||||
|
|
@ -85,11 +87,5 @@ Native parse failures raise `pheon.PheonError`, a subclass of `ValueError`.
|
|||
Invalid buffer or range arguments raise `ValueError` or `TypeError`; file access
|
||||
errors use Python's normal I/O exceptions.
|
||||
|
||||
## Use from Klamath or Masque
|
||||
|
||||
Klamath's `native` extra installs Pheon's packing helpers. Masque's `arrow` extra
|
||||
installs Pheon for layout reads. Use the same Python environment as the
|
||||
companion package.
|
||||
|
||||
See [development](development.md) to test a locally built native library from
|
||||
Python, or the [native API guide](native-api.md) to call the library directly.
|
||||
|
|
|
|||
Loading…
Reference in a new issue