InferenceData

Constructor

InferenceData(**kwargs)

Container for inference data storage using xarray.

Attributes

InferenceData objects store xarray.Dataset as attributes. The InferenceData schema specification contains the guidance related to these attributes.

InferenceData.get_index(key)

IO / Conversion

InferenceData.to_dataframe([groups, ...])

Convert InferenceData to a pandas.DataFrame following xarray naming conventions.

InferenceData.to_json(filename[, groups, ...])

Write InferenceData to a json file.

InferenceData.from_netcdf(filename[, ...])

Initialize object from a netcdf file.

InferenceData.to_netcdf(filename[, ...])

Write InferenceData to file using netcdf4.

InferenceData.from_zarr(store)

Initialize object from a zarr store or path.

InferenceData.to_zarr([store])

Convert InferenceData to a zarr.hierarchy.Group.

InferenceData.chunk([chunks, name_prefix, ...])

InferenceData.compute(**kwargs)

InferenceData.load(**kwargs)

InferenceData.persist(**kwargs)

InferenceData.unify_chunks()

Dictionary interface

InferenceData.groups()

Return all groups present in InferenceData object.

InferenceData.items()

Return a view over the groups and datasets present in the InferenceData object.

InferenceData.values()

Return a view over the Xarray Datasets present in the InferenceData object.

InferenceData contents

InferenceData.add_groups([group_dict, ...])

Add new groups to InferenceData object.

InferenceData.extend(other[, join])

Extend InferenceData with groups from another InferenceData.

InferenceData.assign([variables])

InferenceData.assign_coords([coords])

InferenceData.rename([name_dict, groups, ...])

Perform xarray renaming of variable and dimensions on all groups.

InferenceData.rename_dims([name_dict, ...])

Perform xarray renaming of dimensions on all groups.

InferenceData.set_coords(names)

InferenceData.set_index([indexes, append])

Indexing

InferenceData.isel([groups, filter_groups, ...])

Perform an xarray selection on all groups.

InferenceData.sel([groups, filter_groups, ...])

Perform an xarray selection on all groups.

InferenceData.reset_index(dims_or_levels[, drop])

Computation

InferenceData.map(fun[, groups, ...])

Apply a function to multiple groups.

InferenceData.cumsum([dim, skipna])

InferenceData.max([dim, skipna])

InferenceData.mean([dim, skipna])

InferenceData.median([dim, skipna])

InferenceData.min([dim, skipna])

InferenceData.quantile(q[, dim, ...])

InferenceData.sum([dim, skipna])

Reshaping and reorganizing

InferenceData.stack([dimensions, groups, ...])

Perform an xarray stacking on all groups.

InferenceData.unstack([dim, groups, ...])

Perform an xarray unstacking on all groups.