PottsToolkit API Reference

PottsToolkit exports the curated Level 2 modeling and inspection surface. Execution algorithms, backend types, low-level components, and solution operations remain explicitly owned by CorePotts.

Authoring

PottsToolkit.Authoring.BindingTableType

An immutable, canonically ordered binding collection whose public type does not encode its size. The tuple is deliberately an abstract field: bindings are host authoring data and lower to concrete device descriptors before execution.

PottsToolkit.Authoring.CellPropertyType

A declared finite-cell property with explicit scope, initialization, lifecycle, persistence, visibility, and optionality semantics. Unsupported lifecycle behavior is represented by an explicit rejecting CorePotts policy, never by missing storage.

PottsToolkit.Authoring.lowerMethod
lower(model; dimensions, spacing)

Normalize and lower a Level 2 model into public CorePotts scientific values. This operation is host-only and performs no backend allocation or kernel compilation.

PottsToolkit.Authoring.problemMethod
problem(model, shape, layouts...; capacity, tspan, seed, ...)

Construct the single public CorePotts/SciML PottsProblem from a Level 2 model and typed initial layouts. No PottsToolkit runtime wrapper is introduced.

PottsToolkit.Authoring.semantic_manifestMethod

Return a stable semantic manifest for comparison, provenance, and paper artifacts.

The manifest intentionally declares :not_claimed reconstruction: runtime checkpoints remain a CorePotts concern, and executable model serialization requires a separate opt-in protocol.

Reference models