picopie 0.2.1__tar.gz

picopie-0.2.1/LICENSE

@@ -0,0 +1,210 @@
+Copyright 2026 Mohammadreza Hajianpour <hajianpour.mr@gmail.com>
+Copyright 2026 Vish Vadlamani <global.takeover7@gmail.com>
+
+PicoPie is a Python port and binding of PicoGK (https://github.com/leap71/PicoGK),
+which is Copyright (c) LEAP 71 and licensed under the Apache License, Version 2.0.
+PicoPie is distributed under the same license (Apache-2.0), reproduced in full below.
+
+-------------------------------------------------------------------------------
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Mohammadreza Hajianpour and Vish Vadlamani
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

picopie-0.2.1/MANIFEST.in

@@ -0,0 +1,5 @@
+# Ship the Cython source so the fast extension can be (re)built from an sdist.
+include src/picogk/_fastloop.pyx
+include README.md PLAN.md ROADMAP.md
+recursive-include src/picogk/_native/headers *.h
+recursive-include src/picogk/_assets *.zip

picopie-0.2.1/NOTICE

@@ -0,0 +1,10 @@
+PicoPie
+Copyright 2026 Mohammadreza Hajianpour <hajianpour.mr@gmail.com>
+Copyright 2026 Vish Vadlamani <global.takeover7@gmail.com>
+
+This product is a Python port and binding of PicoGK
+(https://github.com/leap71/PicoGK), Copyright (c) LEAP 71, licensed under the
+Apache License, Version 2.0.
+
+The native runtime it binds (PicoGKRuntime, https://github.com/leap71/PicoGKRuntime)
+is likewise Apache-2.0 and builds upon the OpenVDB and GLFW open-source projects.

picopie-0.2.1/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: picopie
+Version: 0.2.1
+Summary: A Pythonic binding for the PicoGK computational-geometry kernel
+Author-email: Mohammadreza Hajianpour <hajianpour.mr@gmail.com>, Vish Vadlamani <global.takeover7@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Borderliner/PicoPie
+Project-URL: Repository, https://github.com/Borderliner/PicoPie
+Project-URL: Issues, https://github.com/Borderliner/PicoPie/issues
+Project-URL: PicoGK (upstream), https://github.com/leap71/PicoGK
+Keywords: geometry,voxels,openvdb,implicit,cad,additive-manufacturing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy>=1.23
+Provides-Extra: viz
+Requires-Dist: pillow>=9; extra == "viz"
+Requires-Dist: matplotlib>=3.5; extra == "viz"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: picopie[viz]; extra == "dev"
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pytest-timeout; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: hypothesis>=6; extra == "dev"
+Dynamic: license-file
+
+# PicoPie
+
+A **Pythonic binding for [PicoGK](https://github.com/leap71/PicoGK)** — LEAP 71's
+compact computational-geometry kernel for engineering (voxel / level-set modeling
+on OpenVDB).
+
+PicoPie binds the *same native runtime* the official C# library uses — so you get
+identical geometry and performance — then wraps it in an idiomatic, NumPy-friendly
+Python API. No .NET, no compiler, no system libraries: just `pip install picopie`.
+
+```python
+import picogk
+from picogk import Voxels
+
+picogk.init(voxel_size_mm=0.2)
+
+body = Voxels.sphere(radius=10)
+hole = Voxels.sphere(center=(6, 0, 0), radius=6)
+part = body - hole          # boolean subtract → new Voxels
+part.shell_(1.0)            # hollow to a 1 mm wall (in place)
+
+vol, bbox = part.calculate_properties()
+print(f"{vol:.1f} mm³")
+part.to_mesh().save_stl("part.stl")
+```
+
+## Install
+
+```bash
+pip install picopie            # core
+pip install "picopie[viz]"     # + headless slice/mesh PNG helpers (Pillow, matplotlib)
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add picopie
+```
+
+Wheels are self-contained — the native runtime (OpenVDB 13, PicoGK 26.2) and all
+its C++ deps are bundled. Prebuilt for CPython 3.10–3.13 on **Linux (manylinux
+x86-64), macOS (Apple Silicon), and Windows (x64)**.
+
+## Documentation
+
+- **[Quickstart](docs/quickstart.md)** · **[Guide](docs/guide.md)** · **[API reference](docs/api.md)**
+- **Tutorials** — [Novice](docs/tutorials/novice/), [Intermediate](docs/tutorials/intermediate/),
+  [Advanced](docs/tutorials/advanced/)
+- **[QuickLearn](docs/tutorials/QuickLearn.md)** — the whole API in one annotated file
+  (learn-x-in-y-minutes style)
+
+## Features
+
+- **`Voxels`** — primitives (`sphere`, `capsule`), booleans (`+ - &`), offsets,
+  `shell_` (hollow), implicit SDF modeling, and queries (`is_inside`,
+  `closest_point`, `surface_normal`, `ray_cast`, `calculate_properties`).
+- **`Mesh`** — from voxels (marching cubes), NumPy `vertices`/`triangles`, STL/OBJ
+  import **and** export.
+- **`Lattice`** (beams + spheres), **`ScalarField`** / **`VectorField`** (bulk
+  `set_many`/`get_many`), **`Metadata`**, **`PolyLine`**.
+- **File I/O** — `save_vdb` / `load_vdb` round-trips voxels + fields (OpenVDB).
+- **Headless viz** (`[viz]`) — `save_slice_png`, `save_slice_sheet`, `mesh_preview`.
+- **Interactive viewer** — `picogk.show(part)` (GLFW/OpenGL, orbit camera) and
+  `render_png(part, "out.png")` for offscreen renders.
+- **Fast path** — a compiled `_fastloop` extension (~13–28× faster bulk mesh/field
+  transfer) with automatic pure-Python fallback.
+
+## Reliability
+
+PicoPie is validated against the reference and hardened well beyond a naive binding:
+
+- **Parity-tested vs C# PicoGK** on the same runtime — volumes, dims, mesh
+  counts/bbox, and geometric queries match to float precision.
+- **Never aborts** — the native runtime is patched so a C++/OpenVDB error surfaces
+  as a catchable `PicoGKError` instead of killing the process; non-finite inputs are
+  rejected up front. Verified against thousands of fuzzed inputs.
+- **Reproducible & auditable** — every upstream dependency is version-pinned; builds
+  ship an SBOM (`sbom.cdx.json`) and hash-pinned build deps.
+- Green CI across Linux/macOS/Windows; mypy + ruff clean; ~190 tests.
+
+## Development
+
+```bash
+git clone https://github.com/Borderliner/PicoPie && cd PicoPie
+python -m venv .venv && source .venv/bin/activate
+scripts/build_runtime.sh         # build + stage the native runtime (see below)
+pip install -e ".[dev]"
+pytest
+```
+
+Building the native runtime (Linux) needs system deps:
+
+```bash
+sudo apt-get install -y --no-install-recommends \
+  libboost-all-dev libblosc-dev libtbb-dev extra-cmake-modules \
+  xorg-dev mesa-common-dev libgl1-mesa-dev ninja-build cmake g++ git
+scripts/build_runtime.sh
+```
+
+PicoPie locates the runtime automatically: bundled in the wheel (`picogk/_lib/`),
+else under `native/`, else via `$PICOGK_RUNTIME` (full path to the shared library).
+Cross-platform wheels are built by `cibuildwheel` in `.github/workflows/wheels.yml`.
+
+See [`ROADMAP.md`](ROADMAP.md) for the (now-complete) phase history and
+[`PLAN.md`](PLAN.md) for the architecture rationale.
+
+## License
+
+Apache-2.0, matching upstream PicoGK / PicoGKRuntime. Ported by
+Mohammadreza Hajianpour and Vish Vadlamani.

picopie-0.2.1/PLAN.md

@@ -0,0 +1,147 @@
+# PicoPie — A Python binding for PicoGK
+
+> Goal: bring PicoGK's voxel/level-set geometry kernel to Python with an idiomatic,
+> NumPy-friendly API — by binding the **same native runtime** the C# library uses,
+> not by reimplementing the kernel.
+
+**Status: shipped.** Released on PyPI as `picopie`; all phases in [`ROADMAP.md`](ROADMAP.md)
+are complete (cross-platform wheels, parity-validated, hardened, interactive viewer).
+This document records the architecture decisions that got us there.
+
+## 1. Strategy (decided)
+
+| Decision | Choice | Consequence |
+|---|---|---|
+| Binding mechanism | **ctypes** over the native C ABI + a Pythonic layer on top | No compiler needed by end users; no .NET; full control; mirrors `Internals/Interop.cs` + `Base/*.cs` |
+| Platforms | **Linux + macOS + Windows**, shipped as **bundled wheels** | Native runtime must be built/obtained per-platform and packaged via `cibuildwheel` |
+| Viewer | **Headless first** | Skip the 33 viewer fns + GUI-thread/GIL/main-thread-GL complexity in v1 |
+
+### Why a binding, not a rewrite
+PicoGK is itself a thin wrapper. The real engine is **PicoGKRuntime** (C++ on **OpenVDB**
+sparse level sets + **GLFW/OpenGL** viewer). The C# side is just: `[DllImport]` declarations,
+handle-wrapping classes, and pure-C# conveniences (IO, shapes, numerics). The native boundary
+is a **flat C ABI** — `API/PicoGK.h`, **177 `extern "C"` functions**, every object an opaque
+`uint64_t` handle, trivial packed structs. That maps almost 1:1 onto ctypes. Reimplementing the
+kernel would mean reimplementing OpenVDB — huge and slow. We do what C# does: bind the runtime.
+
+## 2. Native C ABI — the surface we bind
+
+- Objects are opaque handles: `PKINSTANCE/PKVOXELS/PKMESH/PKLATTICE/PKSCALARFIELD/PKVECTORFIELD/PKPOLYLINE/PKVDBFILE/PKMETADATA = uint64_t`.
+- First arg of (almost) every function is the **library instance** handle → we hold it as a global singleton, so Python users never pass it (matches C# static `Library`).
+- Structs are `#pragma pack(1)`: `PKVector3{f,f,f}`, `PKVector2`, `PKVector4`, `PKTriangle{i32,i32,i32}`, `PKCoord{i32×3}`, `PKBBox3{vec3,vec3}`, `PKMatrix4x4{vec4×4}`, `PKColorFloat{f×4}`.
+- Library name string: `picogk.26.2` (resolves to `picogk.26.2.dll` / `libpicogk.26.2.dylib` / `libpicogk.26.2.so`).
+
+### Function count by category (177 total)
+`Voxels` 33 · `Viewer` 33 *(skip v1)* · `Library` 24 · `VdbFile` 15 · `Metadata` 15 ·
+`ScalarField` 13 · `Mesh` 13 · `VectorField` 11 · `PolyLine` 9 · `Lattice` 6.
+→ **~110 functions for the headless v1.**
+
+### Two facts that shape the design
+1. **No bulk array transfer.** Mesh verts/tris and field values are accessed one element at a
+   time (`Mesh_GetVertex`, `ScalarField_SetValue`, …). Millions of ctypes calls per mesh is a
+   real perf cliff → plan a compiled fast-loop (see §6). Not v1-blocking.
+2. **Implicit modeling is callback-driven** (`Voxels_RenderImplicit(PKPFnfSdf)` called per point).
+   A Python SDF lambda per-voxel is very slow. Fast path = native primitives + booleans
+   (sphere/capsule/lattice/mesh-render/offset/bool — all present). Python-callback SDFs become an
+   opt-in "flexible but slow" mode.
+
+## 3. Package architecture
+
+```
+picopie/                      # pip name: picopie  ·  import name: picogk
+├── pyproject.toml            # build via scikit-build-core or setuptools + cibuildwheel
+├── src/picogk/
+│   ├── __init__.py           # public API: init(), Voxels, Mesh, Lattice, ScalarField, ...
+│   ├── _native/
+│   │   ├── loader.py         # locate + dlopen runtime (bundled → env var → system)
+│   │   ├── ctypes_types.py   # ctypes Structures (_pack_=1) + numpy dtype mirrors
+│   │   ├── prototypes.py     # GENERATED: argtypes/restype for every C fn (from PicoGK.h)
+│   │   └── _gen_prototypes.py# header parser/codegen (keeps us in sync per runtime version)
+│   ├── library.py            # Library singleton: init(voxel_size), instance handle, log cb
+│   ├── voxels.py             # Voxels (primitives, booleans, offsets, volume, slices, render*)
+│   ├── mesh.py               # Mesh (+ from_voxels, numpy verts/tris)
+│   ├── lattice.py            # Lattice (beams/spheres)
+│   ├── fields.py             # ScalarField, VectorField
+│   ├── polyline.py           # PolyLine
+│   ├── types.py              # Vector3/BBox3/Matrix4x4 helpers ↔ numpy/tuples
+│   ├── metadata.py           # field/voxel metadata
+│   ├── io/                   # stl/obj export, vdb save/load, png slice export
+│   └── _fastloop/            # OPTIONAL Cython/C ext: bulk mesh/field transfer (Phase 4)
+├── tests/                    # pytest, incl. golden comparisons vs C# PicoGK
+├── examples/                 # gyroid lattice, boolean part, mesh→voxelize→offset→export
+└── native/                   # build scripts/CI for PicoGKRuntime per platform
+```
+
+### Core design rules
+- **Handle lifetime** → each wrapper holds `(instance, handle)`; implement `close()`,
+  `__enter__/__exit__`, and `__del__` calling the matching `*_Destroy`. Guard double-free; tear
+  down objects before the library instance. Mirrors C# `IDisposable`.
+- **Library singleton** → `picogk.init(voxel_size_mm=0.1)` creates the instance via
+  `Library_hCreateInstance`; everything else pulls it implicitly (like C# static `Library`).
+- **Log callback** → register a `PKFInfo` CFUNCTYPE routed to Python `logging`; keep a hard ref
+  so it isn't GC'd. Fatal-error flag → raise `PicoGKError`.
+- **NumPy first** → vectors/bboxes accept/return numpy or tuples; fields and mesh buffers expose
+  numpy views; conversions centralized in `types.py`.
+- **Prototype codegen** → parse `PicoGK.h` (regular `PICOGK_API <ret> <Name>(<args>);` grammar)
+  to generate `prototypes.py`. Re-run per runtime version; no hand-maintained 177-fn table.
+
+## 4. C# → Python mapping
+
+| C# (`Base/*.cs`) | Python | Notes |
+|---|---|---|
+| `Library` (static, `Go`) | `picogk.init()` + module globals | hides instance handle |
+| `Voxels` | `picogk.Voxels` | primitives, `+ - &` → `__add__/__sub__/__and__` (BoolAdd/Subtract/Intersect), offsets, `volume()`, slices, `render_mesh/lattice/implicit` |
+| `Mesh` | `picogk.Mesh` | `from_voxels`, `.vertices`/`.triangles` numpy |
+| `Lattice` | `picogk.Lattice` | `add_beam`, `add_sphere` |
+| `ScalarField`/`VectorField` | `picogk.ScalarField`/`VectorField` | get/set, traverse, from-voxels |
+| `PolyLine` | `picogk.PolyLine` | |
+| `BBox3`/`Matrix4x4`/`Vector3` | `picogk.types` | numpy-backed |
+| IO (`MeshIo`,`OpenVdbFile`,`VoxelsIo`,`ImageIo`) | `picogk.io` | STL/OBJ/VDB/PNG |
+| `Viewer` | — | deferred (post-v1) |
+| `Shapes/*`, ShapeKernel | — | follow-on pure-Python port (it's pure C# atop PicoGK) |
+
+## 5. Milestones
+
+- **M0 — Runtime on Linux (gating).** Build PicoGKRuntime from source (vcpkg/CMake: OpenVDB, TBB,
+  Boost, Blosc, zlib, GLFW). Success: `ctypes.CDLL` loads it and `Library_GetVersion` returns a
+  string. *Biggest practical risk; do first.*
+- **M1 — ctypes core.** Header→`prototypes.py` codegen, ctypes structs, loader, `init()`, log
+  callback, handle/dispose. Smoke test: create instance → `Voxels.sphere()` → `volume()`.
+- **M2 — Geometry layer.** Voxels (primitives/booleans/offsets/volume/slices/render), Mesh,
+  Lattice, ScalarField, VectorField, PolyLine, BBox, metadata, NumPy interop.
+- **M3 — IO + examples.** STL/OBJ export, VDB save/load, PNG slice export; 3 headless examples.
+- **M4 — Performance.** Cython/C `_fastloop` for bulk mesh/field transfer (loops in compiled code
+  over the runtime's per-element fns — no runtime rebuild needed); benchmarks.
+- **M5 — Packaging.** `pyproject`, `cibuildwheel` matrix, bundle runtime via
+  `auditwheel`/`delocate`/`delvewheel`; reuse LEAP71 prebuilt mac/Windows runtimes to unblock CI.
+- **M6 — Tests vs C# golden + docs.** Compare volumes/bbox/counts/VDB round-trips against C#
+  reference scripts; API docs; quickstart.
+- **Later** — native viewer (thread/GIL/main-thread-GL), ShapeKernel port.
+
+## 6. Performance plan
+v1: correctness-first, per-element loops in Python with numpy-shaped properties; document the
+hotspot. Phase 4: small Cython extension that re-declares the runtime's per-element fns and loops
+in C, filling contiguous buffers → single numpy copy. Avoids rebuilding the runtime and keeps the
+ctypes layer pure-Python for everything else.
+
+## 7. Testing
+- Golden comparisons vs C# PicoGK on deterministic ops (sphere volume, boolean volumes, offset
+  results, mesh vert/tri counts, voxel dims, VDB round-trip).
+- pytest unit tests per wrapper; memory/handle-leak checks via `Library_n*Allocated` counters.
+- CI runs the headless suite on all three platforms.
+
+## 8. Risks & mitigations
+| Risk | Mitigation |
+|---|---|
+| Building OpenVDB-based runtime on Linux is heavy | Use vcpkg manifest in a manylinux container; cache; reuse LEAP71 prebuilt mac/Win runtimes |
+| Per-element transfer too slow | Cython `_fastloop` (Phase 4); keep ops native where possible |
+| Python-callback SDFs slow | Steer users to native primitives+booleans; mark SDF mode "flexible/slow" |
+| Runtime version drift (`picogk.26.x`) | Generate prototypes from header; pin/version-check at load |
+| Handle lifetime / double-free | Centralized dispose + allocation-counter leak tests |
+| Cross-platform `.so/.dylib/.dll` name resolution | Normalize in `loader.py`; `PICOGK_RUNTIME` env override |
+
+## 9. Immediate next steps
+1. Scaffold the package (`pyproject.toml`, `src/picogk/`, `tests/`, `examples/`).
+2. Vendor `PicoGK.h` + `PicoGKApiTypes.h`; write `_gen_prototypes.py` and emit `prototypes.py`.
+3. Stand up the Linux runtime build (M0) — the gating prerequisite.
+4. Implement `loader.py` + `library.py` + a smoke test (sphere → volume).

picopie-0.2.1/README.md

@@ -0,0 +1,110 @@
+# PicoPie
+
+A **Pythonic binding for [PicoGK](https://github.com/leap71/PicoGK)** — LEAP 71's
+compact computational-geometry kernel for engineering (voxel / level-set modeling
+on OpenVDB).
+
+PicoPie binds the *same native runtime* the official C# library uses — so you get
+identical geometry and performance — then wraps it in an idiomatic, NumPy-friendly
+Python API. No .NET, no compiler, no system libraries: just `pip install picopie`.
+
+```python
+import picogk
+from picogk import Voxels
+
+picogk.init(voxel_size_mm=0.2)
+
+body = Voxels.sphere(radius=10)
+hole = Voxels.sphere(center=(6, 0, 0), radius=6)
+part = body - hole          # boolean subtract → new Voxels
+part.shell_(1.0)            # hollow to a 1 mm wall (in place)
+
+vol, bbox = part.calculate_properties()
+print(f"{vol:.1f} mm³")
+part.to_mesh().save_stl("part.stl")
+```
+
+## Install
+
+```bash
+pip install picopie            # core
+pip install "picopie[viz]"     # + headless slice/mesh PNG helpers (Pillow, matplotlib)
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add picopie
+```
+
+Wheels are self-contained — the native runtime (OpenVDB 13, PicoGK 26.2) and all
+its C++ deps are bundled. Prebuilt for CPython 3.10–3.13 on **Linux (manylinux
+x86-64), macOS (Apple Silicon), and Windows (x64)**.
+
+## Documentation
+
+- **[Quickstart](docs/quickstart.md)** · **[Guide](docs/guide.md)** · **[API reference](docs/api.md)**
+- **Tutorials** — [Novice](docs/tutorials/novice/), [Intermediate](docs/tutorials/intermediate/),
+  [Advanced](docs/tutorials/advanced/)
+- **[QuickLearn](docs/tutorials/QuickLearn.md)** — the whole API in one annotated file
+  (learn-x-in-y-minutes style)
+
+## Features
+
+- **`Voxels`** — primitives (`sphere`, `capsule`), booleans (`+ - &`), offsets,
+  `shell_` (hollow), implicit SDF modeling, and queries (`is_inside`,
+  `closest_point`, `surface_normal`, `ray_cast`, `calculate_properties`).
+- **`Mesh`** — from voxels (marching cubes), NumPy `vertices`/`triangles`, STL/OBJ
+  import **and** export.
+- **`Lattice`** (beams + spheres), **`ScalarField`** / **`VectorField`** (bulk
+  `set_many`/`get_many`), **`Metadata`**, **`PolyLine`**.
+- **File I/O** — `save_vdb` / `load_vdb` round-trips voxels + fields (OpenVDB).
+- **Headless viz** (`[viz]`) — `save_slice_png`, `save_slice_sheet`, `mesh_preview`.
+- **Interactive viewer** — `picogk.show(part)` (GLFW/OpenGL, orbit camera) and
+  `render_png(part, "out.png")` for offscreen renders.
+- **Fast path** — a compiled `_fastloop` extension (~13–28× faster bulk mesh/field
+  transfer) with automatic pure-Python fallback.
+
+## Reliability
+
+PicoPie is validated against the reference and hardened well beyond a naive binding:
+
+- **Parity-tested vs C# PicoGK** on the same runtime — volumes, dims, mesh
+  counts/bbox, and geometric queries match to float precision.
+- **Never aborts** — the native runtime is patched so a C++/OpenVDB error surfaces
+  as a catchable `PicoGKError` instead of killing the process; non-finite inputs are
+  rejected up front. Verified against thousands of fuzzed inputs.
+- **Reproducible & auditable** — every upstream dependency is version-pinned; builds
+  ship an SBOM (`sbom.cdx.json`) and hash-pinned build deps.
+- Green CI across Linux/macOS/Windows; mypy + ruff clean; ~190 tests.
+
+## Development
+
+```bash
+git clone https://github.com/Borderliner/PicoPie && cd PicoPie
+python -m venv .venv && source .venv/bin/activate
+scripts/build_runtime.sh         # build + stage the native runtime (see below)
+pip install -e ".[dev]"
+pytest
+```
+
+Building the native runtime (Linux) needs system deps:
+
+```bash
+sudo apt-get install -y --no-install-recommends \
+  libboost-all-dev libblosc-dev libtbb-dev extra-cmake-modules \
+  xorg-dev mesa-common-dev libgl1-mesa-dev ninja-build cmake g++ git
+scripts/build_runtime.sh
+```
+
+PicoPie locates the runtime automatically: bundled in the wheel (`picogk/_lib/`),
+else under `native/`, else via `$PICOGK_RUNTIME` (full path to the shared library).
+Cross-platform wheels are built by `cibuildwheel` in `.github/workflows/wheels.yml`.
+
+See [`ROADMAP.md`](ROADMAP.md) for the (now-complete) phase history and
+[`PLAN.md`](PLAN.md) for the architecture rationale.
+
+## License
+
+Apache-2.0, matching upstream PicoGK / PicoGKRuntime. Ported by
+Mohammadreza Hajianpour and Vish Vadlamani.