smif.data_layer.data_array module

DataArray provides a thin wrapper around multidimensional arrays and metadata

Summary

Data:

DataArray	DataArray provides access to input/parameter/results data, with conversions to common python data libraries (for example: numpy, pandas, xarray).
INSTALL_WARNING	str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
find_duplicate_indices	Find duplicate indices in a DataFrame
show_null	Shows missing data

Reference

class smif.data_layer.data_array.DataArray(spec: smif.metadata.spec.Spec, data: <MagicMock id='139764769431408'>)

Bases: object

DataArray provides access to input/parameter/results data, with conversions to common python data libraries (for example: numpy, pandas, xarray).

spec

Type:smif.metadata.spec.Spec

data

Type:numpy.ndarray

as_dict()

name

The name of the data that this spec describes.

description

A human-friendly description

dims

Names for each dimension

coords

Coordinate labels for each dimension.

dim_coords(dim)

Coordinates for a given dimension

dim_names(dim)

Coordinate names for a given dimension

dim_elements(dim)

Coordinate elements for a given dimension

unit

The unit for all data points.

shape

The shape of the data array

as_ndarray() → <MagicMock id='139764769427072'>

Access as a numpy.ndarray

as_df() → <MagicMock id='139764769443120'>

Access DataArray as a pandas.DataFrame

classmethod from_df(spec, dataframe)

Create a DataArray from a pandas.DataFrame

as_xarray()

Access DataArray as a xarray.DataArray

classmethod from_xarray(spec, xr_data_array)

Create a DataArray from a xarray.DataArray

update(other)

Update data values with any from other which are non-null

validate_as_full()

Check that the data array contains no NaN values

smif.data_layer.data_array.show_null(dataframe) → <MagicMock id='139764769455264'>

Shows missing data

Returns: Return type:pandas.DataFrame

smif.data_layer.data_array.find_duplicate_indices(dataframe)

Find duplicate indices in a DataFrame

Returns: Return type:list[dict]