boilercv_pipeline.examples.large

boilercv_pipeline.examples.large#

Examples that operate on large files, which are not in the cloud.

Submodules#

Package Contents#

Functions#

example_dataset

Open the example dataset and write it to a destination file with a suffix.

Data#

EXAMPLE

API#

boilercv_pipeline.examples.large.EXAMPLE#

None

boilercv_pipeline.examples.large.example_dataset(
source: str = '',
destination: str = '',
preview: bool = True,
save: bool = True,
**kwargs,
) → collections.abc.Iterator[boilercv.types.DS]#

Open the example dataset and write it to a destination file with a suffix.

Args: source: If provided, use a dataset derived from the example with this suffix. destination: If provided, add this suffix to the destination dataset file. kwargs: Keyword arguments to pass to xarray.Dataset.to_netcdf. preview: Preview the original and modified datasets. save: Whether to save the file.