primap2.pm2io.from_interchange_format

primap2.pm2io.from_interchange_format(data: DataFrame, attrs: dict | None = None, max_array_size: int = 1073741824) → Dataset

Convert dataset from the interchange format to the standard PRIMAP2 format.

Converts an interchange format DataFrame with added metadata to a PRIMAP2 xarray data structure. All column names and attrs are expected to be already in PRIMAP2 format as defined for the interchange format. The attrs dict is given explicitly as the attrs functionality in pandas is experimental.

Parameters:

data: pd.DataFrame

pandas DataFrame in PRIMAP2 interchange format.

attrs: dict, optional

attrs dict as defined for the PRIMAP2 interchange format. Default: use data.attrs.

max_array_size: int, optional

Maximum permitted projected array size. Larger sizes will raise an exception. Default: 1 G, corresponding to about 4 GB of memory usage.

Returns:

obj: xr.Dataset

xr dataset with the converted data