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.Adhesion — Type
Unordered contact/adhesion Hamiltonian declaration.
PottsToolkit.Authoring.Binding — Type
One typed semantic binding. Collection order is never scientific priority.
PottsToolkit.Authoring.BindingTable — Type
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.BoundaryConstraint — Type
Conservative quadratic finite-cell boundary Hamiltonian declaration.
PottsToolkit.Authoring.BoundaryParameters — Type
Target boundary measure and quadratic strength for one finite cell type.
PottsToolkit.Authoring.CapturedFieldValues — Type
Read-only authoring snapshot of array values without encoding field size in its type.
PottsToolkit.Authoring.CellLabelLayout — Type
Dense multi-cell raster whose runtime type is independent of the number of cells.
PottsToolkit.Authoring.CellLayout — Type
A semantic finite-cell raster used only to construct a problem's initial state.
PottsToolkit.Authoring.CellProperty — Type
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.CellPropertyBinding — Type
One cell-type-indexed property column produced by Level 2 lowering.
PottsToolkit.Authoring.CellType — Type
A named finite-cell category. It is never a runtime cell-type index.
PottsToolkit.Authoring.Chemotaxis — Type
Cell-type sensitivity bindings for a named prescribed-field chemotaxis drive.
PottsToolkit.Authoring.ClosedPropertyInterval — Type
Inclusive finite value range checked during authoring and initialization.
PottsToolkit.Authoring.DeclarationReport — Type
One inspectable normalized declaration and its lowering-relevant contract.
PottsToolkit.Authoring.DependencyEdge — Type
One explicit semantic dependency from a consumer to a provider.
PottsToolkit.Authoring.Diagnostic — Type
One structured diagnostic emitted at a named validation stage.
PottsToolkit.Authoring.Division — Type
Scheduled binary finite-cell division with an explicit geometry policy.
PottsToolkit.Authoring.Elongation — Type
Exact conservative penalty on each finite cell's major-axis RMS extent.
PottsToolkit.Authoring.ElongationParameters — Type
Target major-axis RMS extent and quadratic strength for one finite cell type.
PottsToolkit.Authoring.ExecutionFingerprint — Type
Digest of semantic meaning plus the selected execution contract.
PottsToolkit.Authoring.FluctuatingBoundaryConstraint — Type
First-class fluctuating/HST finite-cell boundary-tension declaration.
PottsToolkit.Authoring.FluctuatingVolumeConstraint — Type
First-class fluctuating-volume mechanical declaration, distinct from the exact constraint.
PottsToolkit.Authoring.ImmediateDeath — Type
Scheduled immediate removal of finite cells into one declared medium.
PottsToolkit.Authoring.LoweredModel — Type
Inspectable, host-only result of lowering one normalized Level 2 model.
PottsToolkit.Authoring.Medium — Type
A named medium domain, distinct from a finite CellType.
PottsToolkit.Authoring.MediumLayout — Type
A semantic medium raster used only to construct a problem's initial state.
PottsToolkit.Authoring.ModelFragment — Type
An immutable reusable bundle of declarations with a lexical namespace.
PottsToolkit.Authoring.ModelReport — Type
Public inspectable summary of normalized meaning and its complete expansion.
PottsToolkit.Authoring.NamedCoreComponent — Type
Explicitly name a direct CorePotts component when more than one instance is composed.
PottsToolkit.Authoring.Namespace — Type
An immutable hierarchical namespace used by biological and component identities.
PottsToolkit.Authoring.NormalizedModel — Type
Typed immutable normalized meaning shared by reports, fingerprints, and lowering.
PottsToolkit.Authoring.PairIdentity — Type
Canonical pair identity for directed or symmetric scientific laws.
PottsToolkit.Authoring.PairwiseLaw — Type
Typed pairwise scientific values with explicit symmetry and missing-pair behavior.
PottsToolkit.Authoring.PottsModel — Type
Persistent Julia-native Level 2 biological model.
PottsToolkit.Authoring.PrescribedField — Type
Immutable Level 2 snapshot of a cell-centered prescribed scalar field.
PottsToolkit.Authoring.PreserveConnectivity — Type
Exact global finite-cell connectedness constraint; omit it to permit fragmentation.
PottsToolkit.Authoring.PropertyUpdate — Type
One simultaneous per-cell property addition at an integer-MCS lifecycle boundary.
PottsToolkit.Authoring.ProvenanceEntry — Type
Typed origin record for one normalized declaration.
PottsToolkit.Authoring.SemanticFingerprint — Type
Canonical semantic digest independent of source paths and declaration order.
PottsToolkit.Authoring.SemanticManifest — Type
Portable description of normalized meaning; deliberately not executable serialization.
PottsToolkit.Authoring.SemanticName — Type
A semantic name whose namespace is independent of source and declaration order.
PottsToolkit.Authoring.ShrinkDeath — Type
Scheduled decrement of a target property until CorePotts retires the shrunken cell.
PottsToolkit.Authoring.SourceLocation — Type
Optional source position captured by a future Level 1 spelling; never fingerprinted.
PottsToolkit.Authoring.Transition — Type
Scheduled finite-cell type transition at an integer-MCS boundary.
PottsToolkit.Authoring.UnboundedProperty — Type
Explicitly declare that a property has no value-range invariant.
PottsToolkit.Authoring.ValidationReport — Type
Immutable collection of all independent diagnostics found in one validation pass.
PottsToolkit.Authoring.VolumeConstraint — Type
Conservative quadratic finite-cell volume Hamiltonian declaration.
PottsToolkit.Authoring.VolumeParameters — Type
Target and strength values used by volume constraint declarations.
PottsToolkit.Authoring.Growth — Method
Convenience spelling for deterministic finite-cell target-volume growth.
PottsToolkit.Authoring._compose_value — Method
Compose declarations or fragments without assigning precedence to argument order.
PottsToolkit.Authoring.add — Method
Return a new model with one declaration appended; the original remains unchanged.
PottsToolkit.Authoring.backend_report — Method
Return CorePotts's public, allocation-free host compatibility preflight report.
PottsToolkit.Authoring.execution_fingerprint — Method
Execution identity for cache keys, reports, and exact-replay qualification.
PottsToolkit.Authoring.lower — Method
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.problem — Method
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.remove — Method
Return a new model without the declaration of identity.
PottsToolkit.Authoring.replace — Method
Replace exactly one declaration by semantic identity.
PottsToolkit.Authoring.semantic_manifest — Method
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.
PottsToolkit.Authoring.validate_problem — Method
Validate model-instance facts without compiling a backend or allocating device storage.
Reference models
PottsToolkit.ReferenceModels.chemotaxis_model — Method
Reusable Level 2 single-cell chemotaxis model for one fixed gradient profile.
PottsToolkit.ReferenceModels.chemotaxis_problem — Method
Construct an executable fixed-gradient chemotaxis reference problem.
PottsToolkit.ReferenceModels.differential_adhesion_model — Method
Reusable two-population differential-adhesion Level 2 model.
PottsToolkit.ReferenceModels.differential_adhesion_problem — Method
Construct a deterministic mixed two-population differential-adhesion problem.
PottsToolkit.ReferenceModels.droplet_problem — Method
Modern 2D/3D fluctuating droplet with explicit contact energy.
PottsToolkit.ReferenceModels.elongation_driven_angiogenesis_model — Method
Reusable elongation-driven endothelial-network model.
The elongation term is the exact conservative major-axis RMS Hamiltonian. Connectivity is an independent optional constraint: disabling it makes fragmentation valid model behavior.
PottsToolkit.ReferenceModels.elongation_driven_angiogenesis_problem — Method
Construct a deterministic sparse endothelial seed problem in two or three dimensions.
PottsToolkit.ReferenceModels.monolayer_growth_model — Method
Reusable growth/division/repulsion model for a one-cell monolayer seed.
PottsToolkit.ReferenceModels.monolayer_growth_problem — Method
Construct an executable growth/division/repulsion monolayer problem.
PottsToolkit.ReferenceModels.single_cell_fluctuation_problem — Method
Modern fluctuating-volume reference used by thermodynamic verification.