2026-11-16 16:51:41 -08:00
|
|
|
|
# Building releases
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
2026-11-19 11:06:13 -08:00
|
|
|
|
Build packages locally for distribution. The checkout holds Python build tools
|
|
|
|
|
|
in `.venv/`, release artifacts in `dist/release/`, and Linux wheel caches in
|
|
|
|
|
|
`.cache/wheels/`. Use your installed Rust toolchain and Cargo registry cache.
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
2026-11-17 15:07:51 -08:00
|
|
|
|
## Start a release
|
|
|
|
|
|
|
2026-11-19 11:06:13 -08:00
|
|
|
|
Use Python 3.11+ and Rust 1.88+. Run the commands from the repository root and
|
|
|
|
|
|
start with an empty `dist/release/` directory.
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
|
|
|
|
|
```sh
|
2026-11-17 15:07:51 -08:00
|
|
|
|
python3 -m venv .venv
|
|
|
|
|
|
. .venv/bin/activate
|
2026-11-19 11:06:13 -08:00
|
|
|
|
export PIP_CACHE_DIR="$PWD/.cache/wheels/pip"
|
2026-11-17 15:07:51 -08:00
|
|
|
|
python -m pip install build twine
|
|
|
|
|
|
python -m build --sdist --outdir dist/release
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
```
|
|
|
|
|
|
|
2026-11-17 15:07:51 -08:00
|
|
|
|
Use `python -m build --wheel` to build a wheel for your own machine. For a
|
|
|
|
|
|
portable Linux wheel, use the container below. See [development](development.md)
|
|
|
|
|
|
for compiler checks.
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
2026-11-17 15:07:51 -08:00
|
|
|
|
## Build Linux x86-64 wheels
|
|
|
|
|
|
|
2026-11-19 11:06:13 -08:00
|
|
|
|
On x86-64 Linux, use rootless Podman and a Rust toolchain installed through
|
|
|
|
|
|
`rustup`. Build the portable wheel from the source archive.
|
2026-11-17 15:07:51 -08:00
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
|
python -m pip install 'cibuildwheel==4.3.5'
|
2026-11-19 11:06:13 -08:00
|
|
|
|
python tools/build_manylinux.py dist/release/pheon-*.tar.gz
|
2026-11-17 15:07:51 -08:00
|
|
|
|
```
|
|
|
|
|
|
|
2026-11-19 11:06:13 -08:00
|
|
|
|
The helper pulls the [pinned image](../contrib/wheels/manylinux-image.txt) when
|
|
|
|
|
|
needed and reuses it from `.cache/wheels/podman/storage/`. It keeps Podman’s
|
|
|
|
|
|
storage runtime directory, download scratch space, and wheel caches under
|
|
|
|
|
|
`.cache/wheels/`. Podman still uses the normal system user runtime for host
|
|
|
|
|
|
services. To inspect this checkout’s images, use the same helper.
|
|
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
|
python tools/build_manylinux.py podman image ls
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
cibuildwheel repairs the wheel and tests it on Python 3.11–3.14. The container
|
|
|
|
|
|
uses the host Rust toolchain and Cargo registry through read-only mounts.
|
2026-11-17 15:07:51 -08:00
|
|
|
|
|
|
|
|
|
|
## Build Windows x86-64 packages from Linux
|
|
|
|
|
|
|
|
|
|
|
|
Install MinGW-w64 with `x86_64-w64-mingw32-gcc` on `PATH`. From the project
|
|
|
|
|
|
environment, build the Windows wheel and the standalone CLI:
|
|
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
|
rustup target add x86_64-pc-windows-gnu
|
|
|
|
|
|
PHEON_BUILD_TARGET=x86_64-pc-windows-gnu python -m build --wheel --outdir dist/release
|
|
|
|
|
|
cargo build --locked --release --target x86_64-pc-windows-gnu --bin pheon
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
The `py3-none-win_amd64` wheel lands in `dist/release/`. The executable is
|
|
|
|
|
|
`target/x86_64-pc-windows-gnu/release/pheon.exe`. Test the wheel and CLI on Windows
|
|
|
|
|
|
before publishing.
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
2026-11-16 16:51:41 -08:00
|
|
|
|
## Validate artifacts
|
|
|
|
|
|
|
2026-11-17 15:07:51 -08:00
|
|
|
|
Check the Python package metadata and verify that the packaged crate builds.
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
|
|
|
|
|
```sh
|
2026-11-17 15:07:51 -08:00
|
|
|
|
python -m twine check --strict dist/release/*.tar.gz dist/release/*.whl
|
|
|
|
|
|
cargo publish --dry-run --locked
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
```
|
|
|
|
|
|
|
2026-11-17 15:07:51 -08:00
|
|
|
|
Wheel filenames use `py3-none` plus a platform tag, such as
|
|
|
|
|
|
`manylinux_2_28_x86_64` or `win_amd64`. Use repaired `manylinux_*` wheels for
|
|
|
|
|
|
Linux releases.
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
2026-11-18 12:36:58 -08:00
|
|
|
|
To test a wheel manually, install it in a test environment on the target OS.
|
|
|
|
|
|
Clear `PHEON_LIBRARY` so the checks load the bundled library. Replace the
|
|
|
|
|
|
example path with the wheel you built.
|
Introduce Pheon GDSII parsing and layout review tools
Implement native GDSII reading and writing with Arrow interchange, hierarchy
scans and selective cell loading. Validate numeric packing and array pitches,
and preserve normalized REAL8 encodings exactly within the supported range.
Add standalone dump, structural diff, hierarchy, layer-name annotation and Git
diff commands. Provide scoped text and JSON reports, deterministic comparison,
and record-preserving metadata edits.
Package the shared library and optional Python Arrow readers as pheon using
CFFI ABI mode and Python-independent platform wheels. Include locked source
builds, native API checks, cross-platform artifact workflows, documentation
and regression coverage. Require Rust 1.88 or newer and Python 3.11 or newer.
Validation: 87 native tests, 14 binding tests on Python 3.11/3.13/3.14,
and 71 installed companion integration tests pass. Full, scanned and selected
Arrow layouts match the previous schemas.
2026-11-16 16:21:21 -08:00
|
|
|
|
|
2026-11-17 15:07:51 -08:00
|
|
|
|
```sh
|
2026-11-18 12:36:58 -08:00
|
|
|
|
python -m pip install "path/to/pheon-wheel.whl"
|
2026-11-17 15:07:51 -08:00
|
|
|
|
python -I tools/check_installed.py
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
Build standalone CLI artifacts for each OS and architecture. Include the
|
|
|
|
|
|
executable, license, README, documentation, and Git templates.
|
|
|
|
|
|
|
2026-11-19 11:06:13 -08:00
|
|
|
|
## Publish
|
|
|
|
|
|
|
|
|
|
|
|
Upload the validated Python files you selected, then publish the crate from a
|
|
|
|
|
|
clean release checkout.
|
|
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
|
python -m twine upload --repository pypi FILE ...
|
|
|
|
|
|
cargo publish --locked
|
|
|
|
|
|
```
|