Skip to content

iter_datapoints

python
def iter_datapoints(
    data: xarray.Dataset,
    *,
    dimension: str = "time",
) -> Iterator[xarray.Dataset]

Iterate over individual datapoints in an xarray query result. Each datapoint is selected by position along dimension, removing that dimension and preserving its coordinate as a scalar.

This iterates over an existing result; it does not make requests or stream query pages.

Parameters

data xarray.Dataset

The result of a dataset or collection query.

dimension str

The datapoint dimension to iterate over. Defaults to "time".

Yields

One xarray.Dataset per datapoint, in result order. Empty query results yield no datapoints.

Raises

ValueError when iteration starts if the dataset contains variables but does not have the requested dimension.

Type to search…