def Collection.load(
    time_or_interval: TimeIntervalLike,
    skip_data: bool = False,
    show_progress: bool = False
) -> xarray.Dataset

Load a range of data points in this collection in a specified interval. If no data exists for the requested time or interval, an empty xarray.Dataset is returned.

​
Parameters

​
time_or_interval
TimeIntervalLike

The time or time interval for which to load data. This can be a single time scalar, a tuple of two time scalars, or an array of time scalars.

Valid time scalars are: datetime.datetime objects, strings in ISO 8601 format, or Unix timestamps in seconds.

Behavior for each input type:

  • TimeScalar: If a single time scalar is provided, load returns all data points for that exact millisecond.

  • TimeInterval: If a time interval is provided, load returns all data points in that interval. Intervals can be a tuple of two TimeScalars or a TimeInterval object. Tuples are interpreted as a half-open interval [start, end). With a TimeInterval object, the start_exclusive and end_inclusive parameters control whether the start and end time are inclusive or exclusive.

  • Iterable[TimeScalar]: If an array of time scalars is provided, load constructs a time interval from the first and last time scalar in the array. Here, both the start and end times are inclusive.

​
skip_data
bool

If True, the response contains only the datapoint metadata without the actual dataset-specific fields. Defaults to False.

​
show_progress
bool

If True, a progress bar is displayed when pagination is required. Defaults to False.

​
Returns

An xarray.Dataset containing the requested data points.

Was this page helpful?

Collection.infoCollection.find