emmi.schemas.data.data_specs

Classes

FieldDimSpec	A specification for a group of named data fields and their dimensions.
AeroDataSpecs	Defines the complete data specification for a surrogate model.

Module Contents

class emmi.schemas.data.data_specs.FieldDimSpec

Bases: pydantic.RootModel[dict[str, int]]

A specification for a group of named data fields and their dimensions.

property field_slices: dict[str, slice]

Calculates slice indices for each field in concatenation order.

Return type:

dict[str, slice]

property total_dim: int

Calculates the total dimension of all fields combined.

Return type:

int

keys()

values()

items()

class emmi.schemas.data.data_specs.AeroDataSpecs(/, **data)

Bases: pydantic.BaseModel

Defines the complete data specification for a surrogate model.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

position_dim: int = None

Dimension of the input position vectors.

surface_output_dims: FieldDimSpec

volume_output_dims: FieldDimSpec | None = None

conditioning_dims: FieldDimSpec | None = None

property physics_dim: int

Calculates the total physics dimension from conditioning dimensions.

Return type:

int

property use_physics_features: bool

Determines if physics features are used based on conditioning dimensions.

Return type:

bool

property total_output_dim: int

Calculates the total output dimension by summing surface and volume output dimensions.

Return type:

int