Skip to content

Time Coordinate (forecast)

version: 0.1.0
trait: time_coordinate
profile: forecast

View spec source on GitHub

Run with uvx from release on pypi.org:

uvx --with mlwp-data-specs mlwp.validate_dataset_traits --time forecast <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 --time forecast <DATASET_PATH_OR_URL>

Python API:

from mlwp_data_specs import validate_dataset

report = validate_dataset(ds, time="forecast")

1. Introduction

This document defines trait-level requirements for time coordinates 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 time=forecast profile.

3. Structural Requirements

3.1 Accepted Dimension Variants

  • The dataset MUST include both reference_time and lead_time dimensions.

3.2 Required Coordinates

  • The dataset MUST include the lead_time and reference_time coordinates.

3.3 Optional Coordinates

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

4. Coordinate Metadata Requirements

  • reference_time MUST have standard_name equal to forecast_reference_time or time.
  • lead_time MUST have standard_name equal to forecast_period.
  • lead_time MUST have units in one of: s, seconds, h, hours.
  • If valid_time is present, it MUST have standard_name equal to time.