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', force=False, nbuffer=None, save_interval=None, background_write=False)

Bases: object

connect(stream)

abstract property data

flush()

property is_writing

property save

property writers

class skfdiff.plugins.container.MemoryContainer(path=None, mode='a', *, save='all', force=False, nbuffer=None, save_interval=None, background_write=False)

Bases: Container

property data

class skfdiff.plugins.container.NetCDFContainer(path, mode='a', *, save='all', force=False, nbuffer=None, save_interval=None, background_write=True)

Bases: Container

property data

merge(override=True)

static merge_datafiles(path, override=False)

static retrieve(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 as time-dependant xarray Dataset.

Return type:

xarray.Dataset

class skfdiff.plugins.container.ZarrContainer(path, mode='a', *, save='all', force=False, nbuffer=None, save_interval=None, background_write=False)

Bases: Container

property data

static retrieve(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 as time-dependant xarray Dataset.

Return type:

xarray.Dataset

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

skfdiff.plugins.container.retrieve_container(path: Path, isel: Union[str, dict, int] = 'all', lazy: bool = False)

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

property hv_curve

show()

Module contents