mater-ecosystem

Shared standards, governance, and versioned data exchange contracts for the MATER ecosystem.

mater-ecosystem hosts the cross-cutting documentation, architectural decisions, governance rules, and machine-readable standards shared across MATER projects.

It also publishes mater-interface, the Python package defining the shared data exchange contract between MATER producers and consumers.

Quick Start

Add mater-interface to a uv-managed project:

uv add mater-interface

To use the optional Parquet serializer:

uv add "mater-interface[parquet]"

Import the public data models and validation functions:

from mater_interface import (
    DatasetMetadata,
    Derivation,
    Observation,
    validate_dataset,
    validate_dataset_for_publication,
)

mater-interface provides:

• Validated models for Dataset metadata and Observations
• Dataset-level structural validation
• Client-side validation before Dataset publication
• JSON and optional Parquet serialization
• JSON Schemas and executable conformance cases

Documentation

• Detailed Documentation — Ecosystem architecture, standards, governance, and mater-interface reference
• License — LGPLv3-or-later

Development

Clone the repository:

git clone https://gricad-gitlab.univ-grenoble-alpes.fr/isterre-dynamic-modeling/mater-project/mater-ecosystem.git
cd mater-ecosystem

Install dependencies, including Parquet support:

uv sync --extra parquet

Install just (cross-platform via uv):

uv tool install just-bin

Or download the binary directly from the official releases page.

If you see a PATH warning, run uv tool update-shell and restart your terminal.

Run common development tasks:

just lint
just fix
just test
just schemas