skfdiff.plugins package

Submodules

skfdiff.plugins.container module

class skfdiff.plugins.container.AttrDict(*args, **kwargs)

Bases: dict

class skfdiff.plugins.container.Container(path=None, mode='a', *, save='all', metadata={}, force=False, nbuffer=None, save_interval=None)

Bases: object

connect(stream)

data

flush()

is_writing

merge(override=True)

static merge_datafiles(path, override=False)

metadata

static retrieve(path: path.Path, isel: Union[str, dict, int] = 'all', lazy: bool = False)

Retrieve the data of a persistent container.

Parameters

• path (Path or str) – The folder where the persistent container lives.

• isel (Union[str, dict, int], optional) – can be either “all” or “last”, an integer or a sequence of integer. (the default is “all”)

• lazy (bool, optional) – if True, return a lazy xarray Datasets that will be loaded when requested by the user (using the compute() method). Useful when the data are too big to fit in memory. (the default is False)

Returns

The requested data, with FieldsData.data the fields dataset and FieldsData.metadata the metadata dictionary.

Return type

FieldsData

save

writers

class skfdiff.plugins.container.FieldsData(data, metadata)

Bases: tuple

data

Alias for field number 0

metadata

Alias for field number 1

skfdiff.plugins.container.coerce_attr(key, value)

skfdiff.plugins.displays module

class skfdiff.plugins.displays.Display(skel_data, plot_function)

Bases: object

connect(stream, n=1)

static display_custom(simul, plot_function, n=1)

static display_fields(simul, keys='unknowns', n=1, dim_allowed=(0, 1, 2))

hv_curve

show()

Module contents