Skip to content

V1 schema review #553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tasansal merged 5 commits into from
Jun 26, 2025
Merged

V1 schema review #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6560d31
Update from list to discrete values for coordinate metadata
BrianMichell May 30, 2025
4631f35
Add docs to help users understand difference
BrianMichell May 30, 2025
3a4afff
Update docs and fix case sensitivity.
BrianMichell May 30, 2025
0e1ae57
Linting
BrianMichell May 30, 2025
b835ca8
Add CoordianteMetadata to docs
BrianMichell May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/data_models/version_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@
.. autopydantic_model:: mdio.schemas.v1.variable.Coordinate
:inherited-members: BaseModel

.. autopydantic_model:: mdio.schemas.v1.variable.CoordinateMetadata
:inherited-members: BaseModel

.. automodule:: mdio.schemas.metadata
:members: UserAttributes

Expand Down
26 changes: 18 additions & 8 deletions src/mdio/schemas/v1/variable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,23 @@
from mdio.schemas.v1.stats import StatisticsMetadata
from mdio.schemas.v1.units import AllUnits

CoordinateMetadata = create_model(
"CoordinateMetadata",
**model_fields(AllUnits),
**model_fields(UserAttributes),
__base__=CamelCaseStrictModel,
__doc__="Reduced Metadata, perfect for simple Coordinates.",
)


class Coordinate(NamedArray):
"""An MDIO coordinate array with metadata."""
"""A simple MDIO Coordinate array with metadata.

data_type: ScalarType = Field(..., description="Data type of coordinate.")
metadata: list[AllUnits | UserAttributes] | None = Field(
default=None, description="Coordinate metadata."
)
For large or complex Coordinates, define a Variable instead.
"""

data_type: ScalarType = Field(..., description="Data type of Coordinate.")
metadata: CoordinateMetadata | None = Field(default=None, description="Coordinate Metadata.")


VariableMetadata = create_model(
Expand All @@ -40,14 +49,15 @@ class Coordinate(NamedArray):
**model_fields(StatisticsMetadata),
**model_fields(UserAttributes),
__base__=CamelCaseStrictModel,
__doc__="Complete Metadata for Variables and complex or large Coordinates.",
)


class Variable(NamedArray):
"""An MDIO variable that has coordinates and metadata."""
"""An MDIO Variable that has coordinates and metadata."""

coordinates: list[Coordinate] | list[str] | None = Field(
default=None,
description="Coordinates of the MDIO variable dimensions.",
description="Coordinates of the MDIO Variable dimensions.",
)
metadata: VariableMetadata | None = Field(default=None, description="Variable metadata.")
metadata: VariableMetadata | None = Field(default=None, description="Variable Metadata.")
Loading