icadkit

A Rust-based Python reader for iCAD SX .icd files. Read saved part structure, coordinate frames, names and selected attributes; inspect native box/cylinder parameters; and extract embedded Parasolid geometry.

Version 0.2.0 adds:

• Native part access: hierarchy, internal snapshot definitions, unresolved external references, millimetre local/world part frames, comments and extended text, with per-part Python rows.
• Native parameters and appearance: qualified box/cylinder dimensions and global frames, saved entity palette indices, visibility and layers.
• The exact iCAD V34 SCH_3401212_34101_13006 Parasolid profile through parasolid-core 0.3.0, without an external catalog for qualified resources.
• Optional resource preview and GLB export, with explicit source units and a local browser viewer.

icadkit is experimental. Unsupported geometry remains in the part inventory; unknown values and source ranges are preserved. Part frames, native primitive frames and embedded resource coordinates have separate contracts. Complete assembly geometry, inherited attributes and drawings remain unsupported. Read the support boundaries and changes since 0.1.0.

Installation

The base reader supports standard GIL-enabled CPython 3.10–3.14. Wheel targets are Linux x86_64 (glibc 2.28+), Windows x86_64 and macOS ARM64 (11+):

python -m pip install icadkit==0.2.0

The native extension bundles parasolid-core and has no mandatory Python runtime dependencies. iCAD, Wine and an external SDK are not required. An explicit compatible catalog is needed only for schemas absent from the built-in profiles. Release files are available on the GitHub releases page.

For preview/GLB, install python -m pip install 'icadkit[preview]==0.2.0'. The optional OCCT dependency requires glibc 2.31+ on Linux; see preview requirements. To build from a source checkout or sdist, install Rust 1.88+ and a C linker, then run python -m pip install . (or '.[preview]').

Part structure, frames and attributes

import icadkit

doc = icadkit.read("assembly.icd")
parts = doc.read_parts()
print(parts.status, parts.diagnostics)

for part in parts.walk(include_root=False):
    print(part.name, part.parent_id, part.definition_id)
    print(part.comment, part.extra_info)
    print(part.placement.local_transform, part.placement.world_transform)

rows = parts.to_rows()  # JSON-compatible rows; not certified BOM quantities.

The qualified native profile is the observed little-endian V8L3 3DGLOBAL layout. Part frames use millimetres. Mirrored frames and external-file loading remain unsupported. Extended information is stored text, not interpreted typed engineering properties. Check each scope's status before relying on its values.

Embedded geometry

import icadkit

doc = icadkit.read("model.icd")
for resource in doc.resources:
    print(resource.resource_id, resource.encoding)
    geometry = doc.read_geometry(resource.resource_id)
    print(geometry.status, geometry.diagnostics)
    if geometry.brep is not None:
        print(geometry.brep.counts)
    geometry.require_complete("brep")  # Raises if this scope is incomplete.

inspect() reads leading structure. read() owns the input and indexes resources; decompression and geometry parsing happen on request. A complete resource B-Rep does not establish whole-model completeness. An empty resource list does not establish that a file contains no native geometry.

Paths accept strings or Path objects; bytes means file contents. Structured format errors derive from icadkit.IcadError; file access errors use OSError. See the API reference for schemas, limits and pagination.

Command line

icadkit info --json
icadkit inspect model.icd --json
icadkit parts assembly.icd --json
icadkit resources model.icd --json
icadkit extract model.icd RESOURCE_ID --output body.x_b --json
icadkit check model.icd --target geometry --resource RESOURCE_ID --json
# Requires the preview extra; use the independently known unit of the resource.
icadkit preview model.icd --resource RESOURCE_ID --source-unit m --output preview

Use an ID from resources in place of RESOURCE_ID. Extraction and preview refuse existing output paths. python -m icadkit provides the same commands. Preview requires a declared source unit; its GLB uses metres and resource-local coordinates, without part placement or saved appearance. --write-only --json exports without starting a server. CLI scope statuses and exit codes are explained in the reference.

License

icadkit is offered under PolyForm Noncommercial 1.0.0. Commercial licenses are available from UnRobotics Inc.. Dependencies retain their own licenses and copyright notices. Read the licensing guide, license notice and third-party notices for details.