Skip to content

models

Pydantic models for mesh and project metadata validation.

FieldInfo

Bases: _Strict

Descriptor for one scalar/vector/tensor field on a mesh.

MeshMetadata

Bases: _Strict

Per-mesh metadata generated from the mesh file and cached as a .meta.json sidecar.

BiologicalScale

Bases: StrEnum

Biological scale at which the model operates.

OrganSystem

Bases: StrEnum

Organ system addressed by the dataset.

RendererName

Bases: StrEnum

Built-in renderer selected by a dataset's render config.

PartSpec

Bases: _Strict

One named part for the multi_part renderer.

ScalarField

Bases: _Strict

One selectable scalar field with a display label.

FiberOptions

Bases: _Strict

Fibre glyph overlay for the region_id renderer.

TubeOptions

Bases: _Strict

Tubing options for the multi_part renderer (vessel centrelines).

RenderConfig

Bases: _Strict

Per-dataset render config from the optional JSON render block; engine.renderers.resolve_render_config infers omitted fields from mesh_format and file discovery.

ProjectMetadata

Bases: _Strict

Hand-authored per-dataset descriptor with the scientific context shown in the UI, stored in data/datasets/**/*.json.

is_pvd property

is_pvd

Return True when mesh_format names a PVD dataset, whose data_path is the .pvd file.

compute_mesh_metadata_hash

compute_mesh_metadata_hash()

Return an 8-char hash of MeshMetadata field names and types.