pycogk 0.1.0

Python ctypes bindings for PicoGK runtime with vedo viewer

pycogk

Python package for working with PicoGK from Python.

This is an unofficial community library.

• Official PicoGK project (C++ / C#): https://github.com/leap71/PicoGK
• This Python package repository: https://github.com/ghedo44/PycoGK

The package keeps a PicoGK-like API where practical while adapting parts of the experience to Python, including a vedo-based viewer layer.

Why pycogk

Use pycogk when you want to script computational geometry workflows in Python while leveraging PicoGK runtime capabilities:

1. Build implicit geometry with lattices.
2. Convert to voxels and apply boolean/filter/offset operations.
3. Extract meshes and work with STL/VDB/CLI/TGA.
4. Create scalar/vector field workflows.
5. Preview and iterate quickly from Python.

Install

From PyPI:

pip install pycogk

From this repository:

pip install "git+https://github.com/ghedo44/PycoGK.git"

Import Name

The distribution name is pycogk, but the Python import is:

import picogk

Runtime Notes

pycogk loads the PicoGK native runtime using ctypes.

Bundled runtime targets currently include:

1. win-x64
2. osx-arm64

If your platform is not bundled, set PICOGK_RUNTIME_PATH to a compatible binary.

PowerShell example:

$env:PICOGK_RUNTIME_PATH = "C:\path\to\picogk.1.7.dll"
python your_script.py

Quick Start

from picogk import Lattice, Voxels, Mesh, go

def task() -> None:
  with Lattice() as lat:
    lat.AddSphere((0.0, 0.0, 0.0), 10.0)
    with Voxels.from_lattice(lat) as vox:
      with Mesh.from_voxels(vox) as msh:
        print("triangles:", msh.nTriangleCount())

go(0.5, task, end_on_task_completion=True)

Documentation

New-user docs are organized like a book:

1. Book Home
2. Chapter 1: Orientation
3. Chapter 2: Installation and Runtime
4. Chapter 3: First Project
5. Chapter 4: Core Concepts
6. Chapter 5: Modeling Workflow
7. Chapter 6: Viewer and Interaction
8. Chapter 7: Data IO
9. Chapter 8: Troubleshooting
10. Chapter 9: Production and Publishing

Examples

Runnable examples are in examples:

1. examples/basic_usage.py
2. examples/01_lattice_to_mesh.py
3. examples/02_voxel_boolean_filters.py
4. examples/03_scalar_vector_fields.py
5. examples/04_openvdb_io.py
6. examples/05_stl_io_and_mesh_math.py
7. examples/06_slicing_and_cli.py
8. examples/07_images_and_tga.py
9. examples/08_animation_and_csv.py
10. examples/09_polyline_and_viewer.py
11. examples/10_utils_tempfolder_log.py
12. examples/11_viewer_controls_and_timelapse.py

Status

pycogk is actively developed and has production-readiness gates, but it is still an unofficial project and not a drop-in official replacement.

For readiness details, see:

1. Production Readiness
2. Parity Matrix
3. Publishing Guide