Skip to content

Uncertainty (ensemble)

version: 0.1.0
trait: uncertainty
profile: ensemble

View spec source on GitHub

Run with uvx from release on pypi.org:

uvx --with mlwp-data-specs mlwp.validate_dataset_traits --uncertainty ensemble <DATASET_PATH_OR_URL>

Warning: mlwp-data-specs is not published on PyPI yet, so this command is included for future release usage.

Run directly from GitHub source:

uvx --from "git+https://github.com/mlwp-tools/mlwp-data-specs" mlwp.validate_dataset_traits --uncertainty ensemble <DATASET_PATH_OR_URL>

Python API:

from mlwp_data_specs import validate_dataset

report = validate_dataset(ds, uncertainty="ensemble")

1. Introduction

This document defines trait-level requirements for uncertainty representation in MLWP datasets. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

2. Scope

This specification applies to datasets validated with the uncertainty=ensemble profile.

3. Structural Requirements

3.1 Accepted Dimension Variants

  • The dataset MUST include the member dimension for uncertainty realizations.

3.2 Required Coordinates

  • The dataset MUST include the member coordinate.

3.3 Optional Coordinates

  • The dataset MAY include optional coordinates for this profile: [].

3.4 Optional Dimensions

  • The dataset MAY include optional dimensions for this profile: [].

4. Coordinate Metadata Requirements

  • member MUST have standard_name equal to realization.