InferenceData#

Constructor#

InferenceData([attrs])

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)

get_index method is extended from xarray.Dataset methods.

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 netcdf4 file.

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, ...])

chunk method is extended from xarray.Dataset methods.

InferenceData.compute(**kwargs)

compute method is extended from xarray.Dataset methods.

InferenceData.load(**kwargs)

load method is extended from xarray.Dataset methods.

InferenceData.persist(**kwargs)

persist method is extended from xarray.Dataset methods.

InferenceData.unify_chunks()

unify_chunks method is extended from xarray.Dataset methods.

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])

assign method is extended from xarray.Dataset methods.

InferenceData.assign_coords([coords])

assign_coords method is extended from xarray.Dataset methods.

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)

set_coords method is extended from xarray.Dataset methods.

InferenceData.set_index([indexes, append])

set_index method is extended from xarray.Dataset methods.

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, *)

reset_index method is extended from xarray.Dataset methods.

Computation#

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

Apply a function to multiple groups.

InferenceData.cumsum([dim, skipna, keep_attrs])

cumsum method is extended from xarray.Dataset methods.

InferenceData.max([dim, skipna, keep_attrs])

max method is extended from xarray.Dataset methods.

InferenceData.mean([dim, skipna, keep_attrs])

mean method is extended from xarray.Dataset methods.

InferenceData.median([dim, skipna, keep_attrs])

median method is extended from xarray.Dataset methods.

InferenceData.min([dim, skipna, keep_attrs])

min method is extended from xarray.Dataset methods.

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

quantile method is extended from xarray.Dataset methods.

InferenceData.sum([dim, skipna, min_count, ...])

sum method is extended from xarray.Dataset methods.

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.